Obsidian plugin
All checks were successful
Build and Deploy Nuxt / build (push) Successful in 1m5s

(cherry picked from commit caeff595da)
This commit is contained in:
2026-10-14 14:47:27 +02:00
parent 5cd468ed24
commit 9c6f59f937
6 changed files with 571 additions and 3 deletions

View File

@@ -28,6 +28,7 @@ CI (`.gitea/workflows/deploy.yml`) builds two Docker images on every push to `ma
dragonroll/
├── backend/ Express API (CommonJS, entry: src/index.js)
├── frontend/ Nuxt 4 app (entry: app/app.vue)
├── obsidian-plugin/ Plain JavaScript Obsidian plugin for campaign note import/push
├── docker-compose.yml nginx :3000 -> frontend :3000, /api -> backend :5000
├── nginx.conf reverse proxy rules for the compose stack
├── ecosystem.config.js PM2 config (stale: runs `npm start`, which does not exist — see §9)
@@ -189,7 +190,8 @@ Fetch the file from `/api/public/<filename>`.
`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)
`GET /api/note/list?campaign=` → `{status:'ok', folders, notes}` — notes with `folder: null` (roots);
folder entries include `parentFolder` so clients can rebuild nested folder paths
`GET /api/note/subfolder/list?campaign=&folder=` → `{status:'ok', subfolders, notes}`
`POST /api/note/create` — `{title*,content,campaign*,folder?}` (folder validated against campaign)
`POST /api/note/update` — `{id*, title?, content?, folder?, color?}` — partial, ownership checked
@@ -476,6 +478,23 @@ script; `WindowDefinitions` stores raw keys (`title: 'windows.login'`) and `Wind
configured (`nuxt.config.ts`, `langDir: 'locales/'`, `vueI18n: './i18n.config.ts'`) but its locale files
(`locales/en.json` etc.) are empty `{}` — the custom plugin is what components actually consume.
### 5.9 Obsidian plugin
`obsidian-plugin/` is a plain JavaScript community plugin; copy `main.js` and `manifest.json` into
`<vault>/.obsidian/plugins/dragonroll-sync/` (details in its README). It signs in through
`POST /api/user/login`, saves the 48-hour JWT token in plugin data, and does not save the password.
The user selects a campaign from `GET /api/campaign/list`.
- **Import or refresh campaign notes** reads `/api/note/list` plus `/api/note/subfolder/list` and
creates/updates Markdown files under `Dragonroll/<Campaign>/`, preserving Dragonroll's folder tree.
- **Push active note to Dragonroll** creates a root campaign note or updates the note linked in its
frontmatter.
- `dragonrollId`, `dragonrollCampaign`, and `dragonrollTitle` frontmatter properties link imported
notes. They are omitted from content sent to Dragonroll. Per-note signatures detect local edits;
imports preserve modified local files, and push is explicit.
The plugin uses Obsidian's `requestUrl` helper, so the request path does not depend on browser CORS.
## 6. Conventions
- **Backend**: CommonJS `require`/`module.exports`; files in `services/` are shared infra, `routes/`