Compare commits
1 Commits
4e15b28bf6
...
ai/issue-3
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4355986bd1 |
@@ -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
|
||||||
|
|||||||
@@ -28,8 +28,4 @@ jobs:
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
# The repository is a pnpm workspace: run the root script through corepack,
|
run: npm test
|
||||||
# which picks the pnpm version pinned by "packageManager" in package.json.
|
|
||||||
run: corepack pnpm test
|
|
||||||
env:
|
|
||||||
COREPACK_ENABLE_DOWNLOAD_PROMPT: '0'
|
|
||||||
|
|||||||
708
AGENTS.md
708
AGENTS.md
@@ -1,604 +1,224 @@
|
|||||||
# AGENTS.md — Dragonroll
|
# AGENTS.md — Dragonroll
|
||||||
|
|
||||||
Read this file before touching the code. It is a complete map of the project: layout, architecture,
|
Orientation map, kept short on purpose. Read the file you are about to change: this tells you where to
|
||||||
data model, API, conventions and known landmines. You should not need to explore the rest of the repo
|
look and what will bite you, it does not replace the code. Longer docs: `dragonroll-foundry/README.md`,
|
||||||
to make a correct change.
|
`discord-bot/README.md`, `obsidian-plugin/README.md`.
|
||||||
|
|
||||||
## 1. What this is
|
## 1. What this is
|
||||||
|
|
||||||
**Dragonroll** is a free/open-source helper for tabletop RPG campaigns (notes, campaigns, folders,
|
Free/open-source helper for tabletop RPG campaigns (campaigns, markdown notes, folders, characters,
|
||||||
dice widgets, shared markdown, sounds). It is a two-app monorepo:
|
items, maps, dice widgets, sounds).
|
||||||
|
|
||||||
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth. CommonJS.
|
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth, CommonJS, entry `src/index.js`.
|
||||||
- `frontend/` — **Nuxt 4 / Vue 3** client (Composition API, `<script setup>`), SCSS, axios, marked, mitt, motion.
|
- `frontend/` — **Nuxt 4 / Vue 3** (`<script setup>`), SCSS, axios, marked, mitt, motion, entry `app/app.vue`. No routed pages (§5.1).
|
||||||
|
- `discord-bot/` — Discord bot (slash commands) that talks to the backend with a shared service secret, no login.
|
||||||
|
- `dragonroll-foundry/` — Foundry VTT module (`scripts/api.js`) + optional read-only snapshot bridge.
|
||||||
|
- `obsidian-plugin/` — plain JavaScript Obsidian plugin that imports/pushes campaign notes.
|
||||||
|
- `tests/` — `npm test` (`node --test`, no dependencies installed): Foundry sync toggle and pairing status, map pins, sidebar entries.
|
||||||
|
|
||||||
There is **no** database seeding, no ORM migrations, no linter/formatter config, no Pinia/Vuex, and no
|
No DB seeding, no migrations, no linter/formatter, no Pinia/Vuex. Git: default branch `master` on a
|
||||||
Vue Router pages (see §5.1 — the UI is a window manager, not routed pages). The only automated tests
|
self-hosted Gitea; `.gitea/workflows/deploy.yml` builds and deploys Docker images on push to `master`,
|
||||||
are `tests/*.test.js` (`pnpm test`, Node's built-in runner), which exercise the Foundry module's sync
|
`.gitea/workflows/test.yml` runs `npm test` on every branch.
|
||||||
logic against stubbed Foundry globals.
|
|
||||||
|
|
||||||
Package management is a **pnpm workspace** (`pnpm-workspace.yaml` lists `backend`, `frontend` and
|
## 2. Commands
|
||||||
`discord-bot`). One `pnpm-lock.yaml` at the root, no `package-lock.json` anywhere; `packageManager` in
|
|
||||||
the root `package.json` pins pnpm for corepack. The three packages do not depend on each other, so
|
|
||||||
nothing uses the `workspace:` protocol yet, and `dragonroll-foundry/bridge` stays outside the workspace
|
|
||||||
(it needs nothing but Node built-ins).
|
|
||||||
|
|
||||||
Git: default branch `master`, hosted on a self-hosted Gitea (`git.aranroig.com/BinarySandia04/Dragonroll`).
|
|
||||||
CI (`.gitea/workflows/deploy.yml`) builds three Docker images on every push to `master` — always from
|
|
||||||
the **repository root as build context** (`docker build -f <package>/Dockerfile .`, the Dockerfiles read
|
|
||||||
the workspace manifests) — pushes them to
|
|
||||||
`git.aranroig.com/<user>/dragonroll-{frontend,backend,discord-bot}:latest`, copies `docker-compose.yml` +
|
|
||||||
`nginx.conf` to the deploy host and runs `docker compose pull && up -d`.
|
|
||||||
`.gitea/workflows/test.yml` runs the `corepack pnpm test` suite (frontend + Foundry module tests, no
|
|
||||||
dependencies installed) on every push to any branch, not just `master`.
|
|
||||||
|
|
||||||
## 2. Root layout
|
|
||||||
|
|
||||||
```
|
|
||||||
dragonroll/
|
|
||||||
├── backend/ Express API (CommonJS, entry: src/index.js)
|
|
||||||
├── frontend/ Nuxt 4 app (entry: app/app.vue)
|
|
||||||
├── discord-bot/ discord.js slash commands reading the API
|
|
||||||
├── obsidian-plugin/ Plain JavaScript Obsidian plugin for campaign note import/push
|
|
||||||
├── pnpm-workspace.yaml workspace packages + the dependencies allowed to run install scripts
|
|
||||||
├── pnpm-lock.yaml the only lockfile (root of the workspace)
|
|
||||||
├── docker-compose.yml nginx :3000 -> frontend :3000, /api -> backend :5000
|
|
||||||
├── nginx.conf reverse proxy rules for the compose stack
|
|
||||||
├── ecosystem.config.js PM2 config (stale: runs `npm start`, which does not exist — see §9)
|
|
||||||
├── .gitea/workflows/deploy.yml
|
|
||||||
├── static/media/ README logo images only
|
|
||||||
├── tests/ `node --test` tests (Foundry module sync toggle)
|
|
||||||
├── package.json root workspace: `concurrently`, the `dev` scripts and `test`
|
|
||||||
└── README.md install/run instructions are STALE (see §9)
|
|
||||||
```
|
|
||||||
|
|
||||||
## 3. Commands
|
|
||||||
|
|
||||||
`pnpm` comes from corepack (`packageManager` in `package.json`); `COREPACK_ENABLE_DOWNLOAD_PROMPT=0`
|
|
||||||
keeps corepack from asking in non-interactive shells.
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pnpm install # the whole workspace, once, from the root
|
npm install --prefix backend && npm install --prefix frontend # root `npm install` = concurrently only
|
||||||
# (frontend's `nuxt prepare` runs as its postinstall)
|
npm run dev # backend :5000 + frontend :3000 + discord-bot + scripts/run-foundry.js
|
||||||
|
npm --prefix backend run dev # or --prefix frontend run dev | build | preview
|
||||||
pnpm dev # backend (nodemon, :5000) + frontend (nuxt dev, :3000)
|
npm test
|
||||||
# + discord-bot, plus the Foundry VTT start script from root .env
|
|
||||||
# (FOUNDRY_START_SCRIPT, via scripts/run-foundry.js)
|
|
||||||
pnpm dev:backend # one package, also `pnpm dev:frontend` / `pnpm dev:discord-bot`
|
|
||||||
pnpm --filter ./frontend run build # nuxt build --dotenv .env.production
|
|
||||||
pnpm --filter ./frontend run preview
|
|
||||||
cd frontend && pnpm run build # --filter and `cd` are equivalent inside the workspace
|
|
||||||
|
|
||||||
pnpm test # node --test tests/ (Foundry module sync logic, no dependencies)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
There is no `start` script in either app package and no lint command (`discord-bot` has `start`).
|
No `start` script in backend/frontend and no lint command. Verification = run the dev server and
|
||||||
Verification = run the dev server and exercise the flow (`/api/test` returns a JSON hello);
|
exercise the flow (`GET /api/test` returns a JSON hello).
|
||||||
`pnpm test` covers the Foundry character/item sync toggle and per-actor force sync.
|
|
||||||
|
|
||||||
### Environment files
|
Env: `backend/.env` (`PORT` is read but ignored, `DB_URI`), `frontend/.env` (`NUXT_PUBLIC_API_BASE_URL`),
|
||||||
|
both gitignored; the `.env.production` files are committed. `backend/src/index.js` loads `.env.$NODE_ENV`
|
||||||
|
when `NODE_ENV` is set, otherwise `.env`. The server always listens on **5000**.
|
||||||
|
|
||||||
| File | Contents | Notes |
|
## 3. Backend
|
||||||
|---|---|---|
|
|
||||||
| `.env` (root) | `FOUNDRY_START_SCRIPT=<path to Foundry VTT start.sh>` | gitignored; consumed by `scripts/run-foundry.js` during `pnpm dev` |
|
|
||||||
| `backend/.env` | `PORT=5000`, `DB_URI=mongodb://localhost:27017/dragonroll`, `NODE_ENV=development` | gitignored |
|
|
||||||
| `backend/.env.production` | same shape, `DB_URI=mongodb://192.168.1.7:27017/dragonroll` | **committed** |
|
|
||||||
| `frontend/.env` | `NUXT_PUBLIC_API_BASE_URL=http://localhost:5000/api` | gitignored |
|
|
||||||
| `frontend/.env.production` | `NUXT_PUBLIC_API_BASE_URL=https://dragonroll.aranroig.com/api` | **committed** |
|
|
||||||
|
|
||||||
`backend/src/index.js` loads `.env.$NODE_ENV` when `NODE_ENV` is set, otherwise plain `.env`.
|
`src/models/` one Mongoose schema per file · `src/routes/` thin Express routers · `src/services/`
|
||||||
`PORT` is read from env but **ignored**: the server always listens on 5000.
|
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).
|
||||||
|
|
||||||
## 4. Backend
|
**Auth chain, order matters** (`src/index.js`): `/api/public/*` static → `/api/user`, `/api/discord`,
|
||||||
|
`/api/link`, `/api/foundry` (link + sync, token-authenticated) are mounted **before**
|
||||||
|
`checkAuth = passport.authenticate('jwt', {session:false})`; everything after it
|
||||||
|
(`/api/campaign|note|folder|actor|item|map|foundry`) is JWT-protected. `checkAuth` is assigned without
|
||||||
|
`const` (implicit global). New user routes are public unless the handler calls
|
||||||
|
`passport.authenticate('jwt', {session:false})` inline (`/upload-avatar`, `/update-settings`,
|
||||||
|
`/get-settings`). JWT: payload `{_id, username, name, email, admin, settings}`, 48h; `req.user` is the
|
||||||
|
Mongoose document, so routes use `req.user.id`.
|
||||||
|
|
||||||
```
|
CORS allows any origin for the service link/sync paths only; the app-wide CORS whitelists
|
||||||
backend/src/
|
`http://localhost:3000` and nothing else (production hides behind the nginx same-origin proxy).
|
||||||
├── 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`)
|
**Response envelope** — always HTTP 200, no real status codes:
|
||||||
|
|
||||||
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 `msg` keys: `errors.missing-data`, `errors.notfound`, `errors.internal`, `unauthorized`,
|
Common keys: `errors.missing-data`, `errors.notfound`, `errors.internal`, `unauthorized`,
|
||||||
`login.errors.invalid-credentials`, `register.errors.email-username-exists`. The frontend checks
|
`login.errors.invalid-credentials`, `register.errors.email-username-exists`. `GET /user/has-admin`
|
||||||
`response.data.status !== 'ok'`. `GET /user/has-admin` uses a special `status: "init"` to mean
|
returns `status: 'init'` when no admin exists yet (→ first-run registration).
|
||||||
"no admin exists yet → show first-run registration".
|
|
||||||
|
|
||||||
### Authorization model
|
**Authorization** — single-tenant: a campaign belongs to `createdBy`, everything else hangs off a
|
||||||
|
campaign, and handlers check ownership with a `userOwnsCampaign(campaignId, userId)` helper that is
|
||||||
|
*duplicated per router file* (match that unless you refactor all at once). `settings`, `color`,
|
||||||
|
`description` are free-form fields.
|
||||||
|
|
||||||
Single-tenant per user: a campaign belongs to `createdBy`, everything else hangs off a campaign.
|
**Models** (`*` = required; notes and folders are always ordered `date: -1`):
|
||||||
`note.js` and `folder.js` define a local helper:
|
|
||||||
|
|
||||||
```js
|
- `User` — `name*`, `username*`, `email*` (both unique), `password` (bcrypt, 10 rounds), `admin`, `image`, `setupCode`, `settings`
|
||||||
async function userOwnsCampaign(campaignId, userId) { ... } // duplicated in both files
|
- `Campaign` — `name*`, `createdBy*`→User, `description`, `color`, `settings`, `foundryWorldId`/`foundryWorldTitle`/`foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId`
|
||||||
```
|
- `Note` — `title`, `content` (markdown source), `campaign*`, `folder` (null = root), `color`
|
||||||
|
- `Folder` — `name*`, `campaign*`, `parentFolder` (null = root, self-ref), `color`
|
||||||
|
- `Actor` — `name*`, `campaign*`, `foundryActorId` (unique per campaign), plus free-form sheet fields (`type`, `species`, `className`, `level`, `abilityScores`, `armorClass`, `speed`, `proficiencies`, `traits`, `spells`, `image`) and `inventory[{name,quantity,weight}]` (flattened Foundry items, **not** `Item` docs)
|
||||||
|
- `Item` — `name*`, `campaign*`, `foundryItemId` (unique per campaign), `foundryNames`, `category`, `rarity`, `quantity`, `weight`, `properties`, `description`
|
||||||
|
- `Map` — `name*`, `campaign*`, `image` (filename in `src/uploads`), `gridSize`/`offsetX`/`offsetY`/`scale` (image px), `pins[{note→Note, x, y}]` (addressed by the pin's own `_id`)
|
||||||
|
- `ServiceLinkRequest` — the pending/completed service pairings of §4; `DiscordGuildLink` maps a Discord guild to the Dragonroll user who claimed it
|
||||||
|
|
||||||
Ownership is enforced per handler. `settings`, `color`, `description` and `User.settings` are schemaless
|
**API surface** (all under `/api`, all `{status,msg}`):
|
||||||
`Object`/free-form fields.
|
|
||||||
|
|
||||||
### Data model
|
- `user` — `register`, `verify-setup?code=`, `setup?code=`, `login` (`{usermail,password}`, accepts username or email → `{token}`), `upload-avatar` (multipart `image`, JWT) / `retrieve-avatar?username=`, `has-admin`, `update-settings` / `get-settings`. Files fetched from `/api/public/<filename>`.
|
||||||
|
- `campaign` — `create`, `update`, `list`, `retrieve/:id`, `services` + `service-unlink` (what is linked to a campaign)
|
||||||
|
- `note` — `list?campaign=` (root notes + folders with `parentFolder`), `subfolder/list?campaign=&folder=`, `all?campaign=` (titles only, for the map pin picker), `retrieve/:id`, `create`, `update` (partial), `delete`
|
||||||
|
- `folder` — `list`, `create`, `update`, `rename`, `delete` (recursive: inner notes go to `folder: null`, subfolders re-parent then delete)
|
||||||
|
- `actor` — `list`, `create`, `update` (partial, ownership checked), `upload-image?actor=` (multipart), `delete`
|
||||||
|
- `item` — `list`, `create`, `update` (partial), `delete`
|
||||||
|
- `map` — `list`, `create` (multipart `image` or JSON), `update` (multipart to replace the photo), `delete`, `pin` (`{id,note,x,y}`, re-pinning moves the marker), `unpin` (`{id,pin}`)
|
||||||
|
- `foundry` — read-only proxy over the bridge (`/world`, `/actors`, `/characters`, `/items`, `/actors/:id`, `/items/:id`, `/actors/:id/items`), needs `FOUNDRY_API_URL`
|
||||||
|
|
||||||
```
|
## 4. Service integrations (Foundry, Discord, Obsidian)
|
||||||
User ──< Campaign ──< Note ──?> Folder ──?> Folder (parentFolder, self-ref)
|
|
||||||
└───────< Folder
|
|
||||||
└───────< Actor (Foundry actors, when linked)
|
|
||||||
└───────< Item (Foundry gear + hand-made items)
|
|
||||||
└───────< Map (uploaded images + their grid settings)
|
|
||||||
```
|
|
||||||
|
|
||||||
| Model | File | Fields |
|
Every external service links to a campaign the same way, **never with a Dragonroll login**: it calls
|
||||||
|---|---|---|
|
`POST /api/link/start`, shows the returned sign-up link, and the user opens it in the frontend
|
||||||
| `User` | `models/User.js` | `name*`, `username*` (unique), `email*` (unique), `password` (bcrypt hash, 10 salt rounds), `date`, `admin` (bool, default false), `image`, `setupCode`, `settings` (Object) |
|
(`/link/authorize`, handled by `views/ServiceLinkAuthorize.vue` outside the window app), signs in and
|
||||||
| `Campaign` | `models/Campaign.js` | `name*`, `description`, `color`, `createdBy*` → User, `date`, `settings` (Object), `foundryWorldId` (unique, sparse), `foundryWorldTitle`, `foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId` |
|
picks a campaign at `POST /api/link/complete`; the service then redeems its credential once at
|
||||||
| `Note` | `models/Note.js` | `title`, `content` (markdown source string), `campaign*` → Campaign, `folder` → Folder (null = root), `color` (hex string, sidebar entry background), `date` |
|
`POST /api/link/pickup` (one-time; losing it means a new link). Proofs differ per service
|
||||||
| `Folder` | `models/Folder.js` | `name*`, `campaign*` → Campaign, `parentFolder` → Folder (null = root), `color` (hex string, sidebar entry background), `date` |
|
(`services/service-links.js`): the Discord bot proves itself with the shared secret header, Foundry and
|
||||||
| `Actor` | `models/Actor.js` | `name*`, `type` (`character`\|`npc`\|`creature`), `species`, `className`, `subclass`, `level`, `background`, `challengeRating`, `description`, `image`, `abilityScores{str..cha}`, `armorClass`, `speed`, `proficiencies`, `inventory[{name,quantity,weight}]` (flattened Foundry items, embedded — not `Item` docs), `traits`, `spells` (newline text), `campaign*` → Campaign, `foundryActorId` (unique per campaign), `date` |
|
Obsidian only hold their link code, so what a link grants is decided by the user. Codes are hashed at
|
||||||
| `Item` | `models/Item.js` | `name*`, `category` (`weapon`\|`armor`\|`shield`\|`adventuring-gear`\|`magic-item`\|`consumable`\|`tool`\|`treasure`\|`other`), `rarity` (`common`…`artifact`), `quantity`, `weight`, `properties`, `description`, `campaign*` → Campaign, `foundryItemId` (unique per campaign), `foundryNames` (names Foundry uses for it, keeps dedup stable across a Dragonroll rename), `date` |
|
rest, expire after 10 min, and Obsidian gets a long-lived (365 d) token back.
|
||||||
| `Map` | `models/Map.js` | `name*`, `image` (filename in `src/uploads`), `gridSize` (cell size in image px), `offsetX`/`offsetY` (grid origin in image px), `scale` (distance one cell stands for), `pins[{note → Note, x, y}]` (a note pinned at image px coordinates, addressed by its own `_id`), `campaign*` → Campaign, `date` |
|
|
||||||
|
|
||||||
`*` = required. Notes and folders are ordered by `date: -1` everywhere.
|
Foundry then syncs with that token on `/api/foundry/sync/*` (`routes/foundry-link.js`, mounted before
|
||||||
|
the JWT guard; CORS opened for it): `snapshot` (actors + world items, `fullSync` also prunes),
|
||||||
|
`item-snapshot`, `item-delete`, `characters`, `items`, `status`, `map` / `map-item`, `delete`. Rules:
|
||||||
|
|
||||||
### API reference
|
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row.
|
||||||
|
- **Items are deduplicated by name** — Foundry keeps the same gear once per carrier, so one `Item` per name; `foundryNames` keeps Foundry's names so a Dragonroll rename does not resurrect a duplicate. `services/item-foundry.js` returns `null` for non-gear types and those are skipped.
|
||||||
`POST /api/user/register` — body `{username,email,name,password}`. First registered user becomes
|
- **`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.
|
||||||
`GET /api/user/verify-setup?code=` — `{status:'ok',code}` | `{status:'error',msg:'not-exists'}`
|
|
||||||
|
|
||||||
`POST /api/user/setup?code=` — rate limited. Body `{name,username,email,password}` completes an
|
|
||||||
invited account (`setupCode` is cleared).
|
|
||||||
|
|
||||||
`POST /api/user/login` — rate limited. Body `{usermail,password}` (accepts username **or** email) →
|
|
||||||
`{status:'ok', token, msg:'success'}`.
|
|
||||||
|
|
||||||
`POST /api/user/upload-avatar` — multipart field `image`, JWT required → stores filename on `User.image`.
|
|
||||||
Fetch the file from `/api/public/<filename>`.
|
|
||||||
|
|
||||||
`GET /api/user/retrieve-avatar?username=` → `{status:'ok', image}`
|
|
||||||
|
|
||||||
`GET /api/user/has-admin` → `status: 'ok' | 'init' | 'error'`
|
|
||||||
|
|
||||||
`POST /api/user/update-settings` — JWT inline. Body `{ settings: {...} }` (whole object replaced).
|
|
||||||
`GET /api/user/get-settings` — JWT inline → `{status:'ok', settings}`
|
|
||||||
|
|
||||||
`POST /api/campaign/create` — `{name,description,color,settings}` → `{status:'ok',campaign}`
|
|
||||||
`GET /api/campaign/list` → `{status:'ok',campaigns}`
|
|
||||||
`GET /api/campaign/retrieve/:id` → `{status:'ok',campaign}` (401 when no `req.user.id`)
|
|
||||||
|
|
||||||
`GET /api/note/list?campaign=` → `{status:'ok', folders, notes}` — notes with `folder: null` (roots);
|
|
||||||
folder entries include `parentFolder` so clients can rebuild nested folder paths
|
|
||||||
`GET /api/note/subfolder/list?campaign=&folder=` → `{status:'ok', subfolders, notes}`
|
|
||||||
`GET /api/note/all?campaign=` → `{status:'ok', notes, folders}` — every note of the campaign, titles
|
|
||||||
only (no `content`); the map viewer's note picker and its pin labels
|
|
||||||
`GET /api/note/retrieve/:id` → `{status:'ok',note}` — one note with its content, ownership checked
|
|
||||||
`POST /api/note/create` — `{title*,content,campaign*,folder?}` (folder validated against campaign)
|
|
||||||
`POST /api/note/update` — `{id*, title?, content?, folder?, color?}` — partial, ownership checked
|
|
||||||
`POST /api/note/delete` — `{id}` — **no ownership check** (§9); pulls the note off every map's `pins`
|
|
||||||
|
|
||||||
`GET /api/folder/list?campaign=` → `{status:'ok',folders}`
|
|
||||||
`POST /api/folder/create` — `{name*,campaign*}`
|
|
||||||
`POST /api/folder/rename` — `{id*,name*}`
|
|
||||||
`POST /api/folder/update` — `{id*, name?, color?}` — partial, ownership checked
|
|
||||||
`POST /api/folder/delete` — `{id}` — recursive: notes inside are moved to root (`folder: null`),
|
|
||||||
subfolders re-parented to null then deleted.
|
|
||||||
|
|
||||||
`GET /api/test` — health check.
|
|
||||||
|
|
||||||
`GET /api/actor/list?campaign=` → `{status:'ok',actors}`
|
|
||||||
`POST /api/actor/create` — `{name*,campaign*,type?,species?,className?,subclass?,level?,background?,challengeRating?,description?}`
|
|
||||||
`POST /api/actor/update` — `{id*, name?, species?, className?, subclass?, level?, abilityScores?, armorClass?, speed?, proficiencies?, inventory?, traits?, spells?, image?}` — partial, ownership checked
|
|
||||||
`POST /api/actor/upload-image?actor=` — multipart field `image`
|
|
||||||
`POST /api/actor/delete` — `{id}`
|
|
||||||
|
|
||||||
`GET /api/item/list?campaign=` → `{status:'ok',items}`
|
|
||||||
`POST /api/item/create` — `{name*,campaign*,category?,rarity?,quantity?,weight?,properties?,description?}`
|
|
||||||
`POST /api/item/update` — `{id*, name?, category?, rarity?, quantity?, weight?, properties?, description?}` — partial, ownership checked. `''` for `quantity`/`weight` is ignored, like `/item/create`.
|
|
||||||
`POST /api/item/delete` — `{id}`
|
|
||||||
|
|
||||||
`GET /api/map/list?campaign=` → `{status:'ok',maps}`
|
|
||||||
`POST /api/map/create` — multipart (`image`) or JSON `{name*,campaign*,gridSize?,offsetX?,offsetY?,scale?}` → `{status:'ok',map}`
|
|
||||||
`POST /api/map/update` — `{id*, name?, gridSize?, offsetX?, offsetY?, scale?}`, partial, ownership checked. Send it as
|
|
||||||
multipart with an `image` field to replace the photo (multer reads the other fields from the form; JSON works too).
|
|
||||||
`POST /api/map/delete` — `{id}`
|
|
||||||
`POST /api/map/pin` — `{id*, note*, x, y}` — pins a note of the same campaign at those image px;
|
|
||||||
pinning a note that is pinned already moves that marker → `{status:'ok',map}`
|
|
||||||
`POST /api/map/unpin` — `{id*, pin*}` (`pin` is the subdocument `_id`) → `{status:'ok',map}`
|
|
||||||
|
|
||||||
### 4.1 Foundry integration (actors, items)
|
|
||||||
|
|
||||||
`dragonroll-foundry/` holds the Foundry VTT module (`scripts/api.js`, loaded by `module.json`) and an
|
|
||||||
optional read-only snapshot bridge (`bridge/server.js`). The module talks to Dragonroll with a
|
|
||||||
per-campaign bearer token, **not** a Dragonroll login: `POST /api/foundry/link/complete` redeems a
|
|
||||||
pairing code, stores its hash on `Campaign.foundrySyncTokenHash` and hands the plain token to Foundry
|
|
||||||
once. Every sync route re-reads the campaign from that hash and rejects payloads whose `worldId` is
|
|
||||||
not `Campaign.foundryWorldId` (`syncCampaign` / `requestMatchesWorld`). CORS is opened for
|
|
||||||
`/api/foundry/sync*` and `/foundry/link/complete` in `src/index.js`, before the app-wide CORS.
|
|
||||||
`dragonroll-foundry/README.md` documents pairing, the bridge and its environment variables.
|
|
||||||
|
|
||||||
| Sync route (token) | Meaning |
|
|
||||||
|---|---|
|
|
||||||
| `POST /sync/snapshot` | `{worldId, actors[], items[], fullSync}` — upserts actors, world items and every item embedded in those actors; a `fullSync` also deletes actors/items that are gone |
|
|
||||||
| `POST /sync/item-snapshot` | `{worldId, items[]}` — live world-item edits, upsert only (never prunes) |
|
|
||||||
| `POST /sync/item-delete` | `{worldId, foundryItemId}` — a world item was deleted |
|
|
||||||
| `GET /sync/characters` | Actors the module applies back into Foundry |
|
|
||||||
| `GET /sync/items` | Items the module applies back into Foundry (creates world items for Dragonroll-authored ones) |
|
|
||||||
| `GET /sync/status` | The campaign a sync token belongs to; the module shows it in its **Dragonroll Pairing Status** setting and treats `unauthorized` as the campaign having unlinked the world |
|
|
||||||
| `POST /sync/map` / `POST /sync/map-item` | Store the id mapping after the module creates a document |
|
|
||||||
| `POST /sync/delete` | `{worldId, foundryActorId}` |
|
|
||||||
|
|
||||||
Rules worth knowing before editing this:
|
|
||||||
|
|
||||||
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index so local
|
|
||||||
documents can leave it unset). A document carrying the `dragonroll-foundry.actorId` /
|
|
||||||
`dragonroll-foundry.itemId` flag adopts the matching Dragonroll row.
|
|
||||||
- **Items are deduplicated by name.** Foundry keeps the same gear once per carrier, so one Dragonroll
|
|
||||||
`Item` per name: the first document to claim it keeps the mapping, later copies just return it.
|
|
||||||
`foundryNames` remembers Foundry's names so a Dragonroll rename does not resurrect a duplicate.
|
|
||||||
`services/item-foundry.js` returns `null` for non-gear types (spells, classes, feats, species…),
|
|
||||||
which the sync skips.
|
|
||||||
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events
|
|
||||||
overwrite. Item pruning requires the full snapshot, since only it sees world items and actor copies.
|
|
||||||
- **Autosync is a Foundry-side switch** (`autoSync` client setting, on by default): when off, the
|
|
||||||
module queues no CRUD push, runs no periodic reconcile and sends no startup snapshot; the actor
|
|
||||||
directory's `Dragonroll: Force Sync` entry still pushes the selected actors as an upsert
|
|
||||||
(`fullSync:false`, so it never prunes). The read-only bridge snapshot is not gated by it.
|
|
||||||
- **`pairingStatus` is a setting the module writes, not the GM**: the module settings sentence about
|
|
||||||
whether this world is connected comes from the stored sync token plus the answer from
|
|
||||||
`/sync/status` (checked at world start and every minute), and anything typed into it is replaced.
|
|
||||||
- `Actor.inventory` stays a flattened copy of the actor's embedded items; it is not linked to `Item`.
|
|
||||||
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only
|
|
||||||
bridge, only useful when `FOUNDRY_API_URL` is configured.
|
|
||||||
|
|
||||||
## 5. Frontend
|
## 5. Frontend
|
||||||
|
|
||||||
```
|
### 5.1 Not a routed app
|
||||||
frontend/
|
|
||||||
├── nuxt.config.ts css order (colors, fonts, main, callouts), runtimeConfig.public
|
|
||||||
│ {apiBaseUrl, gitCommit, gitTag, gitBranch, buildDate}, @nuxtjs/i18n module,
|
|
||||||
│ vite.optimizeDeps; git info harvested at build time via execSync
|
|
||||||
├── 18n.config.ts vue-i18n fallbackLocale 'en'
|
|
||||||
├── i18n/locales/ en/ es/ ca/ (+ empty en.json, es.json, ca.json for the nuxt module)
|
|
||||||
├── public/ img/ icons/{iconoir/{regular,solid},Pixelarticons,ui} sounds/ fonts/{5e,amiri,...}
|
|
||||||
│ → served at /img, /icons, /sounds, /fonts
|
|
||||||
└── app/ Nuxt 4 source root (`~/` and `@/` both alias here)
|
|
||||||
├── app.vue real entry: theme setup + start() boot logic + 5 managers
|
|
||||||
├── assets/css/ colors.scss (theme maps → CSS vars), fonts.scss (5e-style font families),
|
|
||||||
│ main.scss (globals, scrollbars, .icon), callouts.scss (Obsidian-like callouts)
|
|
||||||
├── components/
|
|
||||||
│ ├── managers/ WindowManager, ContentManager, ToastManager, TooltipManager, ContextMenuManager
|
|
||||||
│ ├── windows/ ExampleWindow (template to copy), Login, Register, MainMenu, Settings,
|
|
||||||
│ │ CreateCampaign, RenameNote, NewFolder + partials/{WindowHandle,
|
|
||||||
│ │ FixedBottomButtons, BigIconTemplate}
|
|
||||||
│ ├── partials/ ContentSidebar, NestedNoteList, CampaignEntry, EditUserPartial, Spinner,
|
|
||||||
│ │ VersionRender
|
|
||||||
│ ├── layouts/ IconButton, Dropdown, Tabs, ColorPicker (reusable UI atoms)
|
|
||||||
│ └── viewer/ TopBar, statusbar/{StatusBar,FetchStatus}, topbar/{TopSearchBar,SearchResult},
|
|
||||||
│ content/{Content,NoteContainer,Note}, map/MapViewerPane, widgets/{TableWidget,TestWidget,
|
|
||||||
│ inline/RollWidgetInline,display/RollWidgetDisplay}
|
|
||||||
├── composables/ useTheme.ts (theme+accent singletons, localStorage, data-* attrs),
|
|
||||||
│ useEmitter.ts (BROKEN, see §9)
|
|
||||||
├── plugins/ api.ts (inject runtimeConfig apiBaseUrl into the axios instance), i18n.ts
|
|
||||||
└── services/ plain ES modules holding reactive module state (the app has no store)
|
|
||||||
```
|
|
||||||
|
|
||||||
### 5.1 It is not a routed app
|
There is no `app/pages/`. `app/app.vue` renders a shell of managers (`Window`, `Content`, `Toast`,
|
||||||
|
`Tooltip`, `ContextMenu`) and boots: `GetUser()` (JWT in localStorage) → `RestoreCampaign()` or open
|
||||||
|
`main_menu`; no user → `HasAdmin() ? 'login' : 'register' {firstTime:true}`. The one real URL is
|
||||||
|
`/link/authorize` (and the legacy `/discord/authorize`), which renders the service link screen instead
|
||||||
|
of the app.
|
||||||
|
|
||||||
There is no `app/pages/`. `app/app.vue` renders a fixed shell of managers. "Screens" are either:
|
Two kinds of screens: **windows** (floating draggable/resizable overlays) and **content** — the
|
||||||
|
campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`), turned on when
|
||||||
|
`Campaign` becomes non-null. The note column shows the open notes, or the anchored map
|
||||||
|
(`ActivePane` / `AnchoredMap` / `AnchorMap` in `services/Content.js`); `viewer/map/MapViewerPane.vue`
|
||||||
|
renders it both there and in the detached `map_viewer` window. Right-clicking that map pins a campaign
|
||||||
|
note at the spot (`services/MapPins.js` translates image px ↔ screen), clicking the marker opens
|
||||||
|
`pinned_note`.
|
||||||
|
|
||||||
- **Windows** — floating, draggable/resizable overlays (login, main menu, settings…), or
|
### 5.2 The window system
|
||||||
- **Content** — the campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`),
|
|
||||||
shown when `Campaign` state is non-null. The note column shows the open notes, or the map anchored
|
|
||||||
on it (`AnchorMap` / `ActivePane` in `services/Content.js`); the sidebar's notes and maps buttons
|
|
||||||
switch between the two while both keep their state, and `viewer/map/MapViewerPane.vue` renders the
|
|
||||||
map there and inside the `map_viewer` window (a detached anchored map). Right clicking that map pins
|
|
||||||
one of the campaign notes at the spot (`services/MapPins.js` translates between image pixels and
|
|
||||||
the screen and labels the note picker); clicking the marker opens `pinned_note`
|
|
||||||
(`PinnedNoteWindow.vue`), which reads the note itself through `/note/retrieve/:id`.
|
|
||||||
|
|
||||||
Boot sequence (`app.vue` → `start()`):
|
`services/WindowDefinitions.js` is the registry (`{ title: 'i18n.key', component: () => import(...), movable, close?, back? }`)
|
||||||
|
and `services/Windows.js` the runtime: `CreateWindow(type, data)` (one instance per type),
|
||||||
|
`CreateChildWindow(parentId, ...)`, `ClearWindow({type}|{id})`, `GetWindowWithId`, `GetFirstWindowId`,
|
||||||
|
`CallWindow(id, fn, arg)`, `SetSize/SetPosition/ResetPosition(id,'center')/SetMinSize/SetMaxSize/Top`,
|
||||||
|
`getComponent(type)`, `SetupHandle(id, handleRef)`. Adding a window = registry entry + component in
|
||||||
|
`components/windows/`; copy `ExampleWindow.vue`: props `['data']` (merged window object, `props.data.id`),
|
||||||
|
and in `onMounted` call `Top(wrapper)`, `SetupHandle(id, handle)`, `SetSize`, `ResetPosition`.
|
||||||
|
|
||||||
```
|
DOM ids these services depend on — **do not rename**: `window-wrapper-{id}`, `window-handle-{id}`,
|
||||||
GetUser() (JWT in localStorage, un-expired)?
|
`window-resize-handle-{id}`, `context-menu`, `mouse-tooltip`.
|
||||||
├─ yes → RestoreCampaign() (localStorage.selectedCampaignId) → on failure open 'main_menu'
|
|
||||||
└─ no → HasAdmin() ? open 'login' : open 'register' {firstTime:true}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 5.2 The window system (most important thing to understand)
|
### 5.3 Services are the state layer
|
||||||
|
|
||||||
`app/services/WindowDefinitions.js` is the **registry**: key = window type, value =
|
`app/services/` are plain ES modules with module-scope `ref()`s — no DI, no store, singleton by import.
|
||||||
`{ title: 'i18n.key', component: () => import('~/components/windows/X.vue'), movable, close?, back?, ... }`.
|
`Server.js` (axios factory: `Server().get(...)`, interceptor adds `Authorization: Bearer <localStorage.token>`,
|
||||||
Adding a window = add an entry here **and** a component in `app/components/windows/`.
|
`initApi()` from `plugins/api.ts`), `User.js` (`GetUser/SetUser/LogoutUser/HasAdmin`, `GetUserSetting`/
|
||||||
|
`SetUserSetting` server-backed in `User.settings`), `Campaign.js` (`useCampaignService()`, `SetCampaign`
|
||||||
|
writes `localStorage.selectedCampaignId`, `RestoreCampaign`), `Content.js` (§5.1), `Emitter.js`
|
||||||
|
(`mitt()` bus), `Toaster.js`, `Tooltip.js`, `ContextMenu.js`, `Sound.js` (`AddSound` binds
|
||||||
|
`snap.wav` to `.sound-click`), `Marker.js` (marked + widgets), `ActionRegistry.js` (command palette:
|
||||||
|
`register/unregister/search/execute`), `Windows.js` / `WindowDefinitions.js`, `MapPins.js`,
|
||||||
|
`widgets/DiceParser.js`.
|
||||||
|
|
||||||
`app/services/Windows.js` is the runtime. Module-level state: `windows = ref([])`, auto-incrementing
|
### 5.4 Markdown → widgets
|
||||||
`currentId`, `currentIndex` z-index counter. Key exports:
|
|
||||||
|
|
||||||
`CreateWindow(type, data)` (one instance per type — duplicates are ignored),
|
`Marker.js` turns `@name\n…\n@end` (block), `@name[text]` (inline) and `[[target]]` (wiki link) into
|
||||||
`CreateChildWindow(parentId, type, data)` (child dies with parent), `ClearWindow({type}|{id})`
|
placeholder divs/spans; `Note.vue` renders with `v-html` and then mounts each placeholder with its own
|
||||||
(recursive over `children`), `ClearAll()`, `GetWindowWithId(id)`, `GetFirstWindowId(type)`,
|
`createApp(GetWidget(kind, name), {content})` (and unmounts them on re-render). So widgets are isolated
|
||||||
`CallWindow(id, callableName, arg)`, `SetSize/SetPosition/SetMinSize/SetMaxSize/SetResizable/
|
mini-apps: they get only the `content` string and must not rely on the parent app's provides/injection.
|
||||||
SetMovable/ResetPosition(id,'center')/SetOnTop/Top`, `getComponent(type)` (cached `defineAsyncComponent`),
|
Register one in `widget_map` in `Marker.js`, component in `components/viewer/widgets/{inline,display}/`.
|
||||||
and `SetupHandle(id, handleRef)` which wires raw DOM mouse listeners for drag/resize.
|
`DiceParser.js` evaluates `\d*d\d+` with `adv|dis|kh<N>|kl<N>`, `+ - * / ( )`, unary minus, floor
|
||||||
|
division, and returns `{total, steps[]}` that `RollWidgetDisplay.vue` draws.
|
||||||
|
|
||||||
Contract a window component must fulfil (copy `ExampleWindow.vue`):
|
### 5.5 Event bus
|
||||||
|
|
||||||
```vue
|
Events in use: `toast`, `push-note`, `close-note` (removes from the open column only), `delete-note`
|
||||||
<script setup>
|
(closes **and** removes from the sidebar, and drops map pins — the note's close button must not use it),
|
||||||
import { SetupHandle, SetSize, ResetPosition, Top } from '@/services/Windows';
|
`title-updated`, `campaign-entry-created` / `campaign-entry-updated`, `note-created`, `note-renamed`,
|
||||||
import WindowHandle from './partials/WindowHandle.vue';
|
`folder-saved`, `folder-deleted`, `status-bar-update`. Payloads are API documents; the UI note shape is
|
||||||
const handle = ref(null), wrapper = ref(null);
|
`{key, title, text, date}`, mapped at the boundary as `ContentSidebar.fetchCampaignNotes` does. Always
|
||||||
const props = defineProps(['data']); // 'data' = merged {type,id,...WindowDefinitions entry,...CreateWindow data}
|
`import { emitter } from '~/services/Emitter'` — `composables/useEmitter.ts` is broken (§8).
|
||||||
const id = props.data.id;
|
|
||||||
onMounted(() => {
|
|
||||||
Top(wrapper); SetupHandle(id, handle);
|
|
||||||
SetSize(id, { width: 500, height: 380 }); ResetPosition(id, 'center');
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
<template>
|
|
||||||
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
|
||||||
<WindowHandle :window="id" ref="handle"></WindowHandle>
|
|
||||||
<!-- body -->
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
DOM id conventions that `Windows.js`, `WindowHandle.vue` and drag/resize depend on — do not rename:
|
### 5.6 Styling, i18n
|
||||||
`window-wrapper-{id}`, `window-handle-{id}`, `window-resize-handle-{id}`, `context-menu`, `mouse-tooltip`.
|
|
||||||
|
|
||||||
`WindowHandle.vue` reads `title` (translated at mount via `$t`), `close` and `back` off the window
|
`colors.scss` Sass maps (`dark`/`light`, accents `katlum`/`solus`/`silang`) become `--color-*` CSS
|
||||||
object, exposes `setupHandle()`, and plays `/sounds/close.wav` when closed.
|
variables: always style with `var(--color-…)`, never hardcode hex, and add a new key to **both** maps.
|
||||||
|
`useTheme.ts` persists theme/accent and sets `data-theme`/`data-accent` on `<html>`; `app.vue` forces
|
||||||
|
`setTheme('dark')`. Icons are white SVGs with `.icon` (inverted via `--color-icon-invert`), from
|
||||||
|
`/icons/...` or the `pixelarticons` package. Fonts (`fonts.scss`, 5e-style families) and sounds
|
||||||
|
(`/sounds/*.wav`) live in `public/`.
|
||||||
|
|
||||||
### 5.3 Services (`app/services/`) — the state layer
|
i18n: `frontend/i18n/locales/<lang>/<namespace>.json` for `en` (default), `es`, `ca`; `plugins/i18n.ts`
|
||||||
|
nests each file under its filename, so the key is `<file>.<path>` (`$t('windows.login')`). **Add every
|
||||||
Plain modules with module-scope `ref()`s imported directly. No DI, no Pinia. Singleton by import.
|
new string to all three locales.** Namespaces in use: `general`, `login`, `register`, `main-menu`,
|
||||||
|
`settings`, `windows`, `campaigns`, `link`, `foundry`, `discord`.
|
||||||
| Service | Provides |
|
|
||||||
|---|---|
|
|
||||||
| `Server.js` | axios instance (fallback baseURL `http://localhost:5000/api`), `initApi(baseURL)` called by `plugins/api.ts`, request interceptor adding `Authorization: Bearer <localStorage.token>`, `getBaseUrl()`. Default export is a factory: call `Server()` then `.get/.post`. |
|
|
||||||
| `User.js` | `UserStatus` ref, `GetUser()` (decodes JWT, auto-logout on `exp`), `SetUser(token)`, `LoadUser`, `LogoutUser`, `IsAdmin`, `HasAdmin()`, `GetUserSetting(key)` / `SetUserSetting(key,value)` (server-backed, in `User.settings`) |
|
|
||||||
| `Campaign.js` | `useCampaignService()` → `Campaign` (`useState('campaign')`), `SetCampaign(data)` (also writes `localStorage.selectedCampaignId`), `RestoreCampaign()` |
|
|
||||||
| `Content.js` | `ShowContent` ref (drives the campaign workspace: `ContentManager.vue` turns it on from a `watch(Campaign)`, `TopBar` off when leaving a campaign) and the anchored map: `ActivePane` (`'notes'`\|`'map'`), `AnchoredMap`, `SetActivePane`, `AnchorMap`, `ClearAnchoredMap` |
|
|
||||||
| `Emitter.js` | `export const emitter = mitt()` — the app-wide event bus |
|
|
||||||
| `Toaster.js` | `DisplayToast(color, text, duration)` → emits `toast`; `ToastManager.vue` renders it |
|
|
||||||
| `Tooltip.js` | `SetupTooltip()`, `AddTooltip(el, text, {max_width})` (stores on `el._dr_tooltip`), polled visibility via `elementsFromPoint` |
|
|
||||||
| `ContextMenu.js` | `SetupContextMenu()`, `AddContextMenu(el, items, {dropdown:true})`, `ShowContextMenu(items)`, `HideContextMenu()`. Items: `{name, icon?, action?, divider?}` or `{name, context:[...]}` for a submenu; built imperatively into `#context-menu` with `motion` animations |
|
|
||||||
| `Sound.js` | `AddSound(rootEl)` binds `/sounds/snap.wav` to every `.sound-click` inside `rootEl` |
|
|
||||||
| `Marker.js` | marked `Marked` instance + custom extensions, `ParseMarkdown(src)`, `GetWidget(kind,name)` (§5.4) |
|
|
||||||
| `ActionRegistry.js` | `register({id,label,description,execute,isActive?})`, `unregister`, `search(q)` (diacritic-insensitive, prefix-first sort), `execute(id,params)` — powers the command palette |
|
|
||||||
| `Windows.js` / `WindowDefinitions.js` | §5.2 |
|
|
||||||
| `widgets/DiceParser.js` | recursive-descent dice evaluator (§5.5) |
|
|
||||||
|
|
||||||
### 5.4 Markdown → Vue widgets
|
|
||||||
|
|
||||||
`Marker.js` registers three marked extensions:
|
|
||||||
|
|
||||||
| Syntax | Level | Output |
|
|
||||||
|---|---|---|
|
|
||||||
| `@name\n<content>\n@end` | block | `<div class="vue-component-display" data-component data-content>` |
|
|
||||||
| `@name[text]` | inline | `<span class="vue-component-inline" data-component data-content>` |
|
|
||||||
| `[[target]]` | inline | `<span class="vue-link" data-href>` (renders the literal text `Link`) |
|
|
||||||
|
|
||||||
`Note.vue` renders the HTML with `v-html`, then in a `setTimeout(...,0)` calls `mountComponents()`,
|
|
||||||
which `querySelectorAll('.vue-component-display'|'.vue-component-inline')` and mounts each node with a
|
|
||||||
**separate** `createApp(GetWidget(kind, el.dataset.component), { content: el.dataset.content })`.
|
|
||||||
Widgets are therefore isolated mini-apps: they receive only `content` (a string) and must not rely on
|
|
||||||
the parent app's provides/injection.
|
|
||||||
|
|
||||||
Registering a widget = add an entry to `widget_map` in `Marker.js`:
|
|
||||||
|
|
||||||
```js
|
|
||||||
const widget_map = {
|
|
||||||
inline: { roll: () => import("~/components/viewer/widgets/inline/RollWidgetInline.vue") },
|
|
||||||
display: { roll: () => import("~/components/viewer/widgets/display/RollWidgetDisplay.vue") },
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
`Note.vue` also: handles `Ctrl/Cmd+E` (toggle edit/preview, saves on exit) and `Ctrl/Cmd+S` (save via
|
|
||||||
`POST /note/update`), tracks dirty state (white dot in the vertical title strip), and wires
|
|
||||||
Obsidian-style collapsible callouts (`setupCallout()`/`toggleCallout()` + `callouts.scss`).
|
|
||||||
|
|
||||||
### 5.5 Dice grammar (`DiceParser.js`)
|
|
||||||
|
|
||||||
`parse(expr) -> { total, steps[] }`. Tokens: `\d*d\d+` with optional `adv|dis|kh<N>|kl<N>`, integers,
|
|
||||||
`+ - * / ( )`, unary minus. `adv`/`dis` roll 2dN and keep max/min; `kh`/`kl` keep highest/lowest N.
|
|
||||||
Division is `Math.floor`. Guards: count 1–1000, sides 2–10000. `steps` are `{type:'op'|'const'|'dice'}`
|
|
||||||
and `RollWidgetDisplay.vue` turns them into the visual breakdown (kept/dropped/max/min classes).
|
|
||||||
|
|
||||||
### 5.6 Event bus contract
|
|
||||||
|
|
||||||
Every listener in the app (there are only these six `emitter.on` call sites):
|
|
||||||
|
|
||||||
| Event | Payload | Listened by |
|
|
||||||
|---|---|---|
|
|
||||||
| `toast` | `{color,text,duration}` | `ToastManager.vue` |
|
|
||||||
| `push-note` | `{key,title,text,date}` | `NoteContainer.vue` |
|
|
||||||
| `close-note` | note key (string) | `NoteContainer.vue` (removes the note from the open column only) |
|
|
||||||
| `delete-note` | note key (string) | `NoteContainer.vue`, `ContentSidebar.vue`, `NestedNoteList.vue` (real deletion: closes the note **and** removes it from the sidebar), `MapViewerPane.vue` (drops the markers pinned to that note) |
|
|
||||||
| `title-updated` | `{key,title}` | `Note.vue`, `NoteContainer.vue`, `MapViewerPane.vue` (relabels the map pins of that note) |
|
|
||||||
| `status-bar-update` | `{text,icon}` | `FetchStatus.vue` |
|
|
||||||
|
|
||||||
Emitters: `Toaster.js` (`toast`), `ContentSidebar` / `TopSearchBar` (`push-note`), `Note.vue`
|
|
||||||
(`close-note` — the close button must not use `delete-note` or the sidebar entry disappears),
|
|
||||||
`NestedNoteList.vue` (`delete-note`, after `POST /note/delete`), `ContentSidebar` (`title-updated`),
|
|
||||||
`FetchStatus` (self-test emit).
|
|
||||||
|
|
||||||
**Orphan events** — emitted, never subscribed to anywhere (the matching handlers `handleNoteCreated` /
|
|
||||||
`handleNoteRenamed` exist in `ContentSidebar.vue` but were never wired with `emitter.on`; see §9.17):
|
|
||||||
|
|
||||||
| Event | Emitted by | Intended handler |
|
|
||||||
|---|---|---|
|
|
||||||
| `note-created` | `ContentSidebar.createNote`, `TopSearchBar` | `ContentSidebar.handleNoteCreated` (dead) |
|
|
||||||
| `note-renamed` | `RenameNoteWindow.vue` | `ContentSidebar.handleNoteRenamed` (dead) |
|
|
||||||
| `folder-saved` | `NewFolderWindow.vue` | none — sidebar refreshes only via `@reload-notes` from `NestedNoteList` |
|
|
||||||
|
|
||||||
So "create note" currently works because the sidebar mutates its own list, and folder changes need an
|
|
||||||
explicit `fetchCampaignNotes()`. If you rely on an event, check a listener exists.
|
|
||||||
|
|
||||||
Note object shape in the UI layer is `{ key, title, text, date }` (mapped from the API's
|
|
||||||
`{_id,title,content,date}`); convert at the boundary as `ContentSidebar.fetchCampaignNotes` does.
|
|
||||||
|
|
||||||
### 5.7 Theming, fonts, icons, sounds
|
|
||||||
|
|
||||||
- `useTheme.ts` owns `theme` (`'light'|'dark'`) and `accent` (`'katlum'`, type currently narrow) as
|
|
||||||
module singletons, persists to `localStorage`, and sets `data-theme` / `data-accent` on `<html>`.
|
|
||||||
`app.vue` calls `setupTheme()` then forces `setTheme('dark')` on mount.
|
|
||||||
- `colors.scss` holds Sass maps `dark`/`light` (and accents `katlum`/`solus`/`silang`) emitted as
|
|
||||||
**`--color-*` CSS variables**. Always style with `var(--color-...)` (`background`,
|
|
||||||
`window-background`, `button-hover`, `text`, `border`, `icon-invert`, …), never hardcode hex.
|
|
||||||
- Icons are inverted via `filter: invert(var(--color-icon-invert))` — white SVGs + `.icon` class.
|
|
||||||
Reference either as public assets (`/icons/iconoir/regular/xmark.svg`, `/icons/ui/...`,
|
|
||||||
`/icons/Pixelarticons/white/close.svg`) or from the `pixelarticons` npm package
|
|
||||||
(`import SearchIcon from 'pixelarticons/svg/search.svg'`).
|
|
||||||
- Fonts (`fonts.scss` + `public/fonts/5e`): `BookInsanityRemake` (body default), `MrEavesRemake`
|
|
||||||
(headings/window titles), `ScalySansRemake`, `NodestoCapsCondensed`, `SolberaImitationRemake`, etc.
|
|
||||||
- Sounds in `public/sounds/`: `snap.wav` (the `.sound-click` default), `close.wav`, `click.wav`,
|
|
||||||
`dice.wav`, `roll1.wav`, `roll2.wav`, `notify.wav`, `drums.wav`, `lock.wav`, `doors/`.
|
|
||||||
|
|
||||||
### 5.8 i18n
|
|
||||||
|
|
||||||
Locales: `en` (default), `es`, `ca`. Files live at `frontend/i18n/locales/<lang>/<namespace>.json`, and
|
|
||||||
`app/plugins/i18n.ts` globs them and nests each under its **filename** — so the key is
|
|
||||||
`<file>.<path>`, e.g. `i18n/locales/en/main-menu.json` → `$t('main-menu.create-campaign')`.
|
|
||||||
Namespaces in use: `general`, `login`, `register`, `main-menu`, `settings`, `windows`, `campaigns`
|
|
||||||
(`campaigns` currently only exists for `en`). Call it as `$t(...)` in templates or via `useI18n()` in
|
|
||||||
script; `WindowDefinitions` stores raw keys (`title: 'windows.login'`) and `WindowHandle` translates them.
|
|
||||||
|
|
||||||
**Adding a string = add it to all three locales** (`en`, `es`, `ca`); the Nuxt i18n module is also
|
|
||||||
configured (`nuxt.config.ts`, `langDir: 'locales/'`, `vueI18n: './i18n.config.ts'`) but its locale files
|
|
||||||
(`locales/en.json` etc.) are empty `{}` — the custom plugin is what components actually consume.
|
|
||||||
|
|
||||||
### 5.9 Obsidian plugin
|
|
||||||
|
|
||||||
`obsidian-plugin/` is a plain JavaScript community plugin; copy `main.js` and `manifest.json` into
|
|
||||||
`<vault>/.obsidian/plugins/dragonroll-sync/` (details in its README). It signs in through
|
|
||||||
`POST /api/user/login`, saves the 48-hour JWT token in plugin data, and does not save the password.
|
|
||||||
The user selects a campaign from `GET /api/campaign/list`.
|
|
||||||
|
|
||||||
- **Import or refresh campaign notes** reads `/api/note/list` plus `/api/note/subfolder/list` and
|
|
||||||
creates/updates Markdown files under `Dragonroll/<Campaign>/`, preserving Dragonroll's folder tree.
|
|
||||||
- **Push active note to Dragonroll** creates a root campaign note or updates the note linked in its
|
|
||||||
frontmatter.
|
|
||||||
- `dragonrollId`, `dragonrollCampaign`, and `dragonrollTitle` frontmatter properties link imported
|
|
||||||
notes. They are omitted from content sent to Dragonroll. Per-note signatures detect local edits;
|
|
||||||
imports preserve modified local files, and push is explicit.
|
|
||||||
|
|
||||||
The plugin uses Obsidian's `requestUrl` helper, so the request path does not depend on browser CORS.
|
|
||||||
|
|
||||||
## 6. Conventions
|
## 6. Conventions
|
||||||
|
|
||||||
- **Backend**: CommonJS `require`/`module.exports`; files in `services/` are shared infra, `routes/`
|
- Backend: CommonJS; every handler `try/catch` → `{status:'error', msg:'errors.internal'}` + `console.error`.
|
||||||
are thin Express routers, `models/` one Mongoose schema per file exporting `mongoose.model(...)`.
|
- Frontend: Vue 3 `<script setup>`, PascalCase exported service functions (`CreateWindow`, `GetUser`), PascalCase component filenames, kebab-case DOM ids. Both `~/` and `@/` resolve to `app/` — use what the neighbouring file uses.
|
||||||
Every handler is `try/catch` → `{status:'error', msg:'errors.internal'}` + `console.error`.
|
- Components call `Server()` directly (no api layer); `await` and `.then` both appear.
|
||||||
Route logic helpers (like `userOwnsCampaign`) are duplicated per router file today — match that
|
- Comments mix English and Catalan ("Moure aixo") — do not translate unrelated comments while editing.
|
||||||
style unless you refactor both at once.
|
- No formatter: keep diffs minimal and local, the codebase is deliberately rough.
|
||||||
- **Frontend**: Vue 3 `<script setup>`; PascalCase exported functions in `services/` (`CreateWindow`,
|
|
||||||
`GetUser`), camelCase locals; PascalCase component filenames; `kebab-case` DOM ids that services
|
|
||||||
depend on. Both `~/` and `@/` aliases appear in imports (both resolve to `app/`) — follow whatever
|
|
||||||
the neighbouring file uses.
|
|
||||||
- Components talk to the API through `Server()` directly (there is no api-layer abstraction); `await`
|
|
||||||
or `.then` both appear.
|
|
||||||
- Code comments are mixed English and Catalan ("Moure aixo", "Programar un resizer mitjanament
|
|
||||||
competent") — do not "translate" unrelated comments while editing.
|
|
||||||
- No formatter: keep diffs minimal and local; the codebase is deliberately rough.
|
|
||||||
|
|
||||||
## 7. Recipes
|
## 7. Recipes
|
||||||
|
|
||||||
**New API resource**: add `models/X.js`, `routes/x.js` (with `userOwnsCampaign`-style ownership checks
|
- **New API resource**: `models/X.js` + `routes/x.js` (ownership check + `{status,msg}` envelope), then `app.use('/api/x', require('./routes/x'))` in `src/index.js` **after** `checkAuth` if it needs auth.
|
||||||
and the `{status,msg}` envelope), then `app.use('/api/x', require('./routes/x'))` in `src/index.js`
|
- **New window**: `WindowDefinitions.js` entry + `components/windows/X.vue` (§5.2) + strings in `i18n/locales/*/windows.json` (all three locales).
|
||||||
**after** the `checkAuth` line if it needs auth.
|
- **New widget**: component in `components/viewer/widgets/{inline,display}/` + `widget_map` entry in `Marker.js`.
|
||||||
|
- **New palette action**: `register({id, label, description, execute, isActive?})` from `~/services/ActionRegistry` (palette: `Ctrl/Cmd+K` or `/`).
|
||||||
|
- **New theme color**: key in *both* `dark` and `light` maps in `colors.scss`, then `var(--color-<key>)`.
|
||||||
|
|
||||||
**New window**: entry in `WindowDefinitions.js` → component in `app/components/windows/` following
|
## 8. Known landmines (verified in code — do not "fix" silently, never make them worse)
|
||||||
§5.2 → open with `CreateWindow('type', data)` or `CreateChildWindow(parentId, 'type', data)` → strings
|
|
||||||
in `i18n/locales/*/windows.json`.
|
|
||||||
|
|
||||||
**New markdown widget**: component in `app/components/viewer/widgets/{inline|display}/`, register in
|
1. `README.md` says run `./install.sh` / `./start.sh`; **neither exists**. `frontend/README.md` says the frontend is **React**; it is Nuxt/Vue.
|
||||||
`widget_map` in `Marker.js`, consume the `content` prop.
|
2. `services/keys.js` ships the JWT secret `"putyoursecrethere"`, used in production.
|
||||||
|
3. `POST /api/user/register` responds `{status:'ok', code: setupCode}` but `setupCode` is not in scope → caught → the first-run registration actually returns `errors.internal`. The register UI (`RegisterWindow.vue`) drives that flow; fix carefully.
|
||||||
|
4. `POST /api/note/delete` has **no ownership check** (any authenticated user can delete any note id); the other `note.js` handlers and `folder.js` do check.
|
||||||
|
5. `/api/user/*` is mounted before the JWT guard: new routes there are public unless they authenticate inline (`/api/discord` is also before it, but every route there is gated by `requireBot`, the shared bot-secret header). `services/middleware.js`'s `isAdmin` is imported but applied to no route.
|
||||||
|
6. `composables/useEmitter.ts` reads `$emitter` from `useNuxtApp()` and no plugin provides it — use `~/services/Emitter`.
|
||||||
|
7. App-wide CORS only whitelists `http://localhost:3000`; `.env.production` files are committed with internal hosts; `ecosystem.config.js` runs `npm start`, which backend/frontend do not define (PM2 is dead, compose + nginx is the real deploy).
|
||||||
|
8. `Windows.js`: `getComponent` caches `defineAsyncComponent` per type for the whole process (restart the dev server if a new window misbehaves), `SetupHandle` attaches `document` mouse listeners per window and never removes them, and `ClearAll()` iterates `Object.keys(windows)` instead of `windows.value`.
|
||||||
|
9. The frontend treats the JWT as the user cache: `settings` changes need `GetUserSetting`/`SetUserSetting` round-trips, the token payload goes stale.
|
||||||
|
|
||||||
**New command-palette action**: `register({id,label,description,execute,isActive?})` from
|
## 9. Ports
|
||||||
`~/services/ActionRegistry` (see `registerCreateNoteAction` in `TopSearchBar.vue`); palette opens with
|
|
||||||
`Ctrl/Cmd+K` or `/`.
|
|
||||||
|
|
||||||
**New theme color**: add the key to *both* `dark` and `light` maps in `colors.scss`, use
|
`frontend dev :3000` · `backend :5000` (hardcoded) · MongoDB `:27017` · nginx `:3000 → 80` in compose,
|
||||||
`var(--color-<key>)`.
|
proxying `/` → frontend, `/api/` → backend.
|
||||||
|
|
||||||
## 8. Port map
|
|
||||||
|
|
||||||
`frontend dev :3000` · `backend :5000` (hardcoded) · MongoDB `:27017` · nginx `:3000 → 80` inside
|
|
||||||
compose, proxying `/` → `frontend:3000`, `/api/` → `backend:5000`.
|
|
||||||
|
|
||||||
## 9. Known landmines (verified in code — do not "fix" silently, but never make them worse)
|
|
||||||
|
|
||||||
1. `README.md` tells you to run `./install.sh` and `./start.sh`; **neither script exists** in the repo.
|
|
||||||
2. `frontend/README.md` says the frontend is **React**. It is Nuxt/Vue 3.
|
|
||||||
3. `services/keys.js` ships a hardcoded JWT secret `"putyoursecrethere"`, used in prod.
|
|
||||||
4. `src/index.js` sets CORS `origin: 'http://localhost:3000'` only — the production origin
|
|
||||||
(`https://dragonroll.aranroig.com`) is not whitelisted; in production the nginx same-origin proxy
|
|
||||||
is what hides this.
|
|
||||||
5. `POST /api/user/register` responds `{status:'ok', code: setupCode}` but `setupCode` is not defined
|
|
||||||
in that scope → ReferenceError → caught → the first-run registration actually returns
|
|
||||||
`errors.internal`. Fix carefully: the register UI (`RegisterWindow.vue`) drives the first-admin flow.
|
|
||||||
6. `POST /api/note/delete` has **no ownership check** (any authenticated user can delete any note id).
|
|
||||||
`folder.js` and the other `note.js` handlers do check.
|
|
||||||
7. `composables/useEmitter.ts` reads `$emitter` from `useNuxtApp()`, but **no plugin provides it** —
|
|
||||||
always import `{ emitter }` from `~/services/Emitter` instead.
|
|
||||||
8. `ecosystem.config.js` runs `npm start` in both apps; neither package defines a `start` script → PM2
|
|
||||||
would fail. Compose/nginx is the real deployment path.
|
|
||||||
9. `/api/user/*` is entirely mounted before the JWT guard (see §4); new user routes are public unless
|
|
||||||
they call `passport.authenticate('jwt', {session:false})` inline.
|
|
||||||
10. `checkAuth` in `src/index.js` is assigned without `const` (implicit global).
|
|
||||||
11. `ClearAll()` in `Windows.js` iterates `Object.keys(windows)` (the ref object, not `.value`) — it
|
|
||||||
does not behave like the name suggests.
|
|
||||||
12. `GetWidget`/`getComponent` caches are process-global and never invalidated; new widget/window types
|
|
||||||
need a dev-server restart if HMR misbehaves.
|
|
||||||
13. `Windows.js` `SetupHandle` attaches `mousemove`/`mouseup` listeners on `document` for **every**
|
|
||||||
window and never removes them; they early-return on `win.movable` but still accumulate.
|
|
||||||
14. `Note.vue` mounts widgets with `createApp` and never unmounts them — leaked apps remain when note
|
|
||||||
content is re-rendered.
|
|
||||||
15. `User.js` (frontend) treats the JWT as the user cache: `settings` changes require
|
|
||||||
`SetUserSetting`/`GetUserSetting` round-trips, the token payload goes stale.
|
|
||||||
16. `.env.production` files (both apps) are committed and contain internal hosts.
|
|
||||||
17. `note-created`, `note-renamed` and `folder-saved` are emitted with **no subscribers**; the sidebar's
|
|
||||||
`handleNoteCreated` / `handleNoteRenamed` are unwired dead code (§5.6). The sidebar refreshes its
|
|
||||||
tree only on `campaignId` change, on mount, on the manual refresh button, or on `@reload-notes`
|
|
||||||
from `NestedNoteList.vue`.
|
|
||||||
18. `SetShowContent` (`services/Content.js`) and `services/middleware.js`'s `isAdmin` are exported /
|
|
||||||
imported but never used; `ContentManager.vue` never hides the workspace again once shown.
|
|
||||||
|
|||||||
@@ -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
@@ -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
|
||||||
|
|||||||
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
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
|
||||||
combinator, which the current CSS minifier rejects. */
|
|
||||||
.steps > * {
|
|
||||||
font-size: 12px;
|
font-size: 12px;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
.steps :deep(.roll-val){
|
.steps :deep(.roll-val){
|
||||||
display: inline-flex;
|
display: inline-flex;
|
||||||
|
|||||||
12707
frontend/package-lock.json
generated
Normal file
12707
frontend/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
326
package-lock.json
generated
Normal file
326
package-lock.json
generated
Normal file
@@ -0,0 +1,326 @@
|
|||||||
|
{
|
||||||
|
"name": "dragonroll",
|
||||||
|
"lockfileVersion": 3,
|
||||||
|
"requires": true,
|
||||||
|
"packages": {
|
||||||
|
"": {
|
||||||
|
"devDependencies": {
|
||||||
|
"concurrently": "^9.2.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/ansi-regex": {
|
||||||
|
"version": "5.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
|
||||||
|
"integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=8"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/ansi-styles": {
|
||||||
|
"version": "4.3.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
|
||||||
|
"integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"color-convert": "^2.0.1"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=8"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/chalk": {
|
||||||
|
"version": "4.1.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
|
||||||
|
"integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"ansi-styles": "^4.1.0",
|
||||||
|
"supports-color": "^7.1.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=10"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/chalk/chalk?sponsor=1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/chalk/node_modules/supports-color": {
|
||||||
|
"version": "7.2.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
|
||||||
|
"integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"has-flag": "^4.0.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=8"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/cliui": {
|
||||||
|
"version": "8.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
|
||||||
|
"integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "ISC",
|
||||||
|
"dependencies": {
|
||||||
|
"string-width": "^4.2.0",
|
||||||
|
"strip-ansi": "^6.0.1",
|
||||||
|
"wrap-ansi": "^7.0.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=12"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/color-convert": {
|
||||||
|
"version": "2.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
|
||||||
|
"integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"color-name": "~1.1.4"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=7.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/color-name": {
|
||||||
|
"version": "1.1.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
|
||||||
|
"integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/concurrently": {
|
||||||
|
"version": "9.2.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/concurrently/-/concurrently-9.2.1.tgz",
|
||||||
|
"integrity": "sha512-fsfrO0MxV64Znoy8/l1vVIjjHa29SZyyqPgQBwhiDcaW8wJc2W3XWVOGx4M3oJBnv/zdUZIIp1gDeS98GzP8Ng==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"chalk": "4.1.2",
|
||||||
|
"rxjs": "7.8.2",
|
||||||
|
"shell-quote": "1.8.3",
|
||||||
|
"supports-color": "8.1.1",
|
||||||
|
"tree-kill": "1.2.2",
|
||||||
|
"yargs": "17.7.2"
|
||||||
|
},
|
||||||
|
"bin": {
|
||||||
|
"conc": "dist/bin/concurrently.js",
|
||||||
|
"concurrently": "dist/bin/concurrently.js"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/open-cli-tools/concurrently?sponsor=1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/emoji-regex": {
|
||||||
|
"version": "8.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
|
||||||
|
"integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/escalade": {
|
||||||
|
"version": "3.2.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz",
|
||||||
|
"integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=6"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/get-caller-file": {
|
||||||
|
"version": "2.0.5",
|
||||||
|
"resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
|
||||||
|
"integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "ISC",
|
||||||
|
"engines": {
|
||||||
|
"node": "6.* || 8.* || >= 10.*"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/has-flag": {
|
||||||
|
"version": "4.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
|
||||||
|
"integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=8"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/is-fullwidth-code-point": {
|
||||||
|
"version": "3.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
|
||||||
|
"integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=8"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/require-directory": {
|
||||||
|
"version": "2.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
|
||||||
|
"integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=0.10.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/rxjs": {
|
||||||
|
"version": "7.8.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.8.2.tgz",
|
||||||
|
"integrity": "sha512-dhKf903U/PQZY6boNNtAGdWbG85WAbjT/1xYoZIC7FAY0yWapOBQVsVrDl58W86//e1VpMNBtRV4MaXfdMySFA==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"dependencies": {
|
||||||
|
"tslib": "^2.1.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/shell-quote": {
|
||||||
|
"version": "1.8.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.8.3.tgz",
|
||||||
|
"integrity": "sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 0.4"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/sponsors/ljharb"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/string-width": {
|
||||||
|
"version": "4.2.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
|
||||||
|
"integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"emoji-regex": "^8.0.0",
|
||||||
|
"is-fullwidth-code-point": "^3.0.0",
|
||||||
|
"strip-ansi": "^6.0.1"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=8"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/strip-ansi": {
|
||||||
|
"version": "6.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
|
||||||
|
"integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"ansi-regex": "^5.0.1"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=8"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/supports-color": {
|
||||||
|
"version": "8.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz",
|
||||||
|
"integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"has-flag": "^4.0.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=10"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/chalk/supports-color?sponsor=1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/tree-kill": {
|
||||||
|
"version": "1.2.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/tree-kill/-/tree-kill-1.2.2.tgz",
|
||||||
|
"integrity": "sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"bin": {
|
||||||
|
"tree-kill": "cli.js"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/tslib": {
|
||||||
|
"version": "2.8.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz",
|
||||||
|
"integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "0BSD"
|
||||||
|
},
|
||||||
|
"node_modules/wrap-ansi": {
|
||||||
|
"version": "7.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
|
||||||
|
"integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"ansi-styles": "^4.0.0",
|
||||||
|
"string-width": "^4.1.0",
|
||||||
|
"strip-ansi": "^6.0.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=10"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/chalk/wrap-ansi?sponsor=1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/y18n": {
|
||||||
|
"version": "5.0.8",
|
||||||
|
"resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
|
||||||
|
"integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "ISC",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=10"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/yargs": {
|
||||||
|
"version": "17.7.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz",
|
||||||
|
"integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"cliui": "^8.0.1",
|
||||||
|
"escalade": "^3.1.1",
|
||||||
|
"get-caller-file": "^2.0.5",
|
||||||
|
"require-directory": "^2.1.1",
|
||||||
|
"string-width": "^4.2.3",
|
||||||
|
"y18n": "^5.0.5",
|
||||||
|
"yargs-parser": "^21.1.1"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=12"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/yargs-parser": {
|
||||||
|
"version": "21.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
|
||||||
|
"integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "ISC",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=12"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,15 +1,9 @@
|
|||||||
{
|
{
|
||||||
"name": "dragonroll-workspace",
|
|
||||||
"private": true,
|
|
||||||
"packageManager": "pnpm@10.28.2",
|
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"concurrently": "^9.2.1"
|
"concurrently": "^9.2.1"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "concurrently -k -n BACKEND,FRONTEND,DISCORD-BOT,FOUNDRY -c blue,green,yellow,magenta \"DEBUG=* pnpm --filter ./backend run dev\" \"pnpm --filter ./frontend run dev\" \"pnpm --filter ./discord-bot run start\" \"node scripts/run-foundry.js\"",
|
"dev": "concurrently -k -n BACKEND,FRONTEND,DISCORD-BOT,FOUNDRY -c blue,green,yellow,magenta \"DEBUG=* npm --prefix backend run dev\" \"npm --prefix frontend run dev\" \"npm --prefix discord-bot start\" \"node scripts/run-foundry.js\"",
|
||||||
"dev:backend": "DEBUG=* pnpm --filter ./backend run dev",
|
|
||||||
"dev:frontend": "pnpm --filter ./frontend run dev",
|
|
||||||
"dev:discord-bot": "pnpm --filter ./discord-bot run start",
|
|
||||||
"test": "node --test tests/"
|
"test": "node --test tests/"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
9814
pnpm-lock.yaml
generated
9814
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1,10 +0,0 @@
|
|||||||
packages:
|
|
||||||
- backend
|
|
||||||
- frontend
|
|
||||||
- discord-bot
|
|
||||||
|
|
||||||
# pnpm blocks install scripts of dependencies by default; these two place their
|
|
||||||
# native binaries through theirs and have to be allowed to run them.
|
|
||||||
onlyBuiltDependencies:
|
|
||||||
- '@parcel/watcher'
|
|
||||||
- esbuild
|
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
// Runs the Foundry Virtual Tabletop start script defined by FOUNDRY_START_SCRIPT
|
// Runs the Foundry Virtual Tabletop start script defined by FOUNDRY_START_SCRIPT
|
||||||
// in the root .env file. Used by `pnpm dev` via concurrently.
|
// in the root .env file. Used by `npm run dev` via concurrently.
|
||||||
const { spawn } = require('node:child_process');
|
const { spawn } = require('node:child_process');
|
||||||
const fs = require('node:fs');
|
const fs = require('node:fs');
|
||||||
const path = require('node:path');
|
const path = require('node:path');
|
||||||
|
|||||||
@@ -1,122 +0,0 @@
|
|||||||
// Tests for Syndria98/dragonroll#29: the monorepo is a pnpm workspace, so running or installing it
|
|
||||||
// goes through pnpm (`pnpm install`, `pnpm dev`, `pnpm test`) and the images are built with the
|
|
||||||
// workspace manifests instead of one npm lockfile per package.
|
|
||||||
//
|
|
||||||
// These checks only read the manifests, the Dockerfiles and the workflows, so they need no installed
|
|
||||||
// dependencies. They fail when a package is added to the repository without joining the workspace, or
|
|
||||||
// when a build step slips back to npm and its deleted `package-lock.json`.
|
|
||||||
//
|
|
||||||
// Run with `pnpm test` from the repository root, or `node --test tests/`.
|
|
||||||
|
|
||||||
const { test } = require("node:test");
|
|
||||||
const assert = require("node:assert/strict");
|
|
||||||
const fs = require("node:fs");
|
|
||||||
const path = require("node:path");
|
|
||||||
|
|
||||||
const root = path.join(__dirname, "..");
|
|
||||||
|
|
||||||
const read = (...parts) => fs.readFileSync(path.join(root, ...parts), "utf8");
|
|
||||||
|
|
||||||
const workspace = read("pnpm-workspace.yaml");
|
|
||||||
const rootManifest = JSON.parse(read("package.json"));
|
|
||||||
|
|
||||||
// `dragonroll-foundry/bridge` is deliberately left out: it depends on nothing but Node built-ins, it
|
|
||||||
// is not part of `pnpm dev`, and its README runs it with `npm start --prefix foundry/bridge`.
|
|
||||||
const apps = ["backend", "frontend", "discord-bot"];
|
|
||||||
|
|
||||||
function packageJsonOf(pkg) {
|
|
||||||
return JSON.parse(read(pkg, "package.json"));
|
|
||||||
}
|
|
||||||
|
|
||||||
// The items of a top-level `key:` list of pnpm-workspace.yaml, quotes dropped.
|
|
||||||
function yamlList(key) {
|
|
||||||
const block = new RegExp(`${key}\\n((?:\\s+-.*\\n?)+)`).exec(workspace)?.[1] ?? "";
|
|
||||||
return [...block.matchAll(/^\s+-\s+'?([^'\s]+)'?\s*$/gm)].map((match) => match[1]);
|
|
||||||
}
|
|
||||||
|
|
||||||
test("every app package of the monorepo belongs to the pnpm workspace", () => {
|
|
||||||
const listed = yamlList("packages:");
|
|
||||||
for (const pkg of apps) {
|
|
||||||
assert.ok(listed.includes(pkg), `${pkg} must be listed in pnpm-workspace.yaml`);
|
|
||||||
assert.ok(fs.existsSync(path.join(root, pkg, "package.json")), `${pkg} must have a package.json`);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the workspace root is private and pins one pnpm version for corepack", () => {
|
|
||||||
assert.equal(rootManifest.private, true, "the workspace root must not be publishable");
|
|
||||||
assert.match(rootManifest.packageManager, /^pnpm@\d+\.\d+\.\d+$/, "packageManager must pin pnpm");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("npm lockfiles stay gone and pnpm-lock.yaml is the only lockfile", () => {
|
|
||||||
const lockfiles = ["", ...apps].flatMap((pkg) => [
|
|
||||||
path.join(root, pkg, "package-lock.json"),
|
|
||||||
path.join(root, pkg, "yarn.lock"),
|
|
||||||
]);
|
|
||||||
const present = lockfiles.filter((lockfile) => fs.existsSync(lockfile));
|
|
||||||
assert.deepEqual(present, [], `only pnpm-lock.yaml may exist, found ${present.join(", ")}`);
|
|
||||||
assert.ok(fs.existsSync(path.join(root, "pnpm-lock.yaml")), "pnpm-lock.yaml must be committed");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("`pnpm dev` runs the whole monorepo through the workspace instead of npm --prefix", () => {
|
|
||||||
const dev = rootManifest.scripts.dev;
|
|
||||||
assert.match(dev, /^concurrently -k/, "the dev script keeps running every app together");
|
|
||||||
assert.ok(!/\bnpm\b/.test(dev), "the dev script must not call npm");
|
|
||||||
for (const pkg of apps) {
|
|
||||||
assert.ok(
|
|
||||||
dev.includes(`pnpm --filter ./${pkg}`),
|
|
||||||
`the dev script must run ${pkg} through the workspace: ${dev}`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
// The Foundry launcher is not a package, so concurrently keeps driving it.
|
|
||||||
assert.match(dev, /node scripts\/run-foundry\.js/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("every app package can be started on its own", () => {
|
|
||||||
// `pnpm dev:<package>`; building stays `pnpm --filter ./frontend run build`.
|
|
||||||
for (const pkg of apps) {
|
|
||||||
const script = rootManifest.scripts[`dev:${pkg}`];
|
|
||||||
assert.ok(script, `the root needs a dev:${pkg} script`);
|
|
||||||
assert.match(script, new RegExp(`pnpm --filter ./${pkg} run \\w+`));
|
|
||||||
const packageScript = packageJsonOf(pkg).scripts[/run (\w+)$/.exec(script)[1]];
|
|
||||||
assert.ok(packageScript, `${pkg} must define the script dev:${pkg} runs`);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the Dockerfiles install with pnpm from the workspace root", () => {
|
|
||||||
for (const pkg of apps) {
|
|
||||||
const dockerfile = read(pkg, "Dockerfile");
|
|
||||||
assert.match(dockerfile, /corepack enable/, `${pkg}: pnpm must come from corepack`);
|
|
||||||
assert.match(
|
|
||||||
dockerfile,
|
|
||||||
/COPY pnpm-workspace\.yaml pnpm-lock\.yaml package.json/,
|
|
||||||
`${pkg}: the workspace manifests must be copied before installing`
|
|
||||||
);
|
|
||||||
assert.match(
|
|
||||||
dockerfile,
|
|
||||||
new RegExp(`pnpm install --frozen-lockfile[^\\n]*--filter \\./${pkg}`),
|
|
||||||
`${pkg}: dependencies must be installed from the lockfile, filtered to this package`
|
|
||||||
);
|
|
||||||
assert.ok(!/\bnpm (ci|install)\b/.test(dockerfile), `${pkg}: must not fall back to npm install`);
|
|
||||||
}
|
|
||||||
// The images are built from the repository root, so the manifests are in the context.
|
|
||||||
const deploy = read(".gitea", "workflows", "deploy.yml");
|
|
||||||
for (const pkg of apps) {
|
|
||||||
assert.ok(
|
|
||||||
deploy.includes(`-f ./${pkg}/Dockerfile .`),
|
|
||||||
`${pkg} must be built with the repository root as build context`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the test workflow runs the suite through pnpm", () => {
|
|
||||||
assert.match(read(".gitea", "workflows", "test.yml"), /corepack pnpm test/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the workspace allows the dependencies that build native binaries to run their scripts", () => {
|
|
||||||
// pnpm skips install scripts of dependencies by default; the frontend build needs these two to
|
|
||||||
// place their native binary.
|
|
||||||
const allowed = yamlList("onlyBuiltDependencies:");
|
|
||||||
for (const dependency of ["esbuild", "@parcel/watcher"]) {
|
|
||||||
assert.ok(allowed.includes(dependency), `${dependency} must be listed in onlyBuiltDependencies`);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
Reference in New Issue
Block a user