nuxt-unified-ui 0.5.1 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -2
- package/skills/nuxt-unified-ui/SKILL.md +14 -6
- package/skills/nuxt-unified-ui/references/code-style.md +73 -18
- package/skills/nuxt-unified-ui/references/dialogs-impl.md +1 -1
- package/skills/nuxt-unified-ui/references/dialogs.md +11 -0
- package/skills/nuxt-unified-ui/references/resources.md +285 -0
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "nuxt-unified-ui",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.5.
|
|
4
|
+
"version": "0.5.2",
|
|
5
5
|
"main": "./nuxt.config.ts",
|
|
6
6
|
"types": "./index.d.ts",
|
|
7
7
|
"exports": {
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
],
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@formkit/tempo": "1.1.0",
|
|
23
|
-
"@iconify-json/lucide": "1.2.
|
|
23
|
+
"@iconify-json/lucide": "1.2.123",
|
|
24
24
|
"@nuxt/kit": "4.5.2",
|
|
25
25
|
"@nuxt/ui": "4.10.0",
|
|
26
26
|
"@nuxtjs/i18n": "10.6.0",
|
|
@@ -5,10 +5,12 @@ description: >-
|
|
|
5
5
|
install/extend the layer, required CSS, modules/config, radashi radXxx
|
|
6
6
|
auto-imports, un-form / useForm, launchFormPickerDialog /
|
|
7
7
|
launchChoicePickerDialog, toast helpers, un-card / un-typography, pages /
|
|
8
|
-
definePageMeta, ufetch / useUFetch wrapping,
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
8
|
+
definePageMeta, ufetch / useUFetch wrapping, unified resources
|
|
9
|
+
(server plugins, REST handleResource*, resource-manager dashboard /
|
|
10
|
+
customization), attribute order/defaults, and whitespace/formatting
|
|
11
|
+
conventions for all Nuxt-generated code. Use when working in or consuming
|
|
12
|
+
nuxt-unified-ui, declaring or customizing resources, or whenever generating
|
|
13
|
+
Vue/Nuxt code that must match unified code style.
|
|
12
14
|
---
|
|
13
15
|
|
|
14
16
|
# nuxt-unified-ui
|
|
@@ -23,6 +25,7 @@ This is the **only** installable skill in this repo. Deep topics live under `ref
|
|
|
23
25
|
|
|
24
26
|
- Installing / extending `nuxt-unified-ui` as a Nuxt layer
|
|
25
27
|
- Using `un-form`, dialogs, toasts, `un-card`, radashi `radXxx`, etc.
|
|
28
|
+
- Declaring or customizing **unified resources** (plugins, REST, dashboard)
|
|
26
29
|
- **Whenever generating or editing Nuxt/Vue/server code** that must follow the unified look (whitespace, wrapping, template shape, sectioning)
|
|
27
30
|
|
|
28
31
|
## References (read as needed)
|
|
@@ -30,6 +33,7 @@ This is the **only** installable skill in this repo. Deep topics live under `ref
|
|
|
30
33
|
| Topic | File |
|
|
31
34
|
|-------|------|
|
|
32
35
|
| **Code style (mandatory)** | [references/code-style.md](references/code-style.md) |
|
|
36
|
+
| Unified resources (plugins → REST → dashboard) | [references/resources.md](references/resources.md) |
|
|
33
37
|
| Pages / routing | [references/pages.md](references/pages.md) |
|
|
34
38
|
| Data fetching (`ufetch` / `useUFetch`) | [references/data-fetching.md](references/data-fetching.md) |
|
|
35
39
|
| Layer install + required CSS | [references/layer-setup.md](references/layer-setup.md) |
|
|
@@ -52,14 +56,15 @@ Absolute highlights:
|
|
|
52
56
|
|
|
53
57
|
- `<script setup>` only — **never** `lang="ts"`; no TS annotations in Vue (runtime prop types)
|
|
54
58
|
- 2-space indent; single quotes; semicolons; trailing commas in multi-line literals
|
|
59
|
+
- **`.js` / `.ts` file start:** two leading blank lines, **except** when the file starts with imports — then **no** blank lines before the first `import`
|
|
55
60
|
- Double blank lines between major sections; blank line before `</script>`; **two** blanks before `<template>`
|
|
56
61
|
- Non-trivial async/functions: blank line after `{`, double blank between major steps, blank before `}`
|
|
57
62
|
- `else` / `catch` on their own line after `}`
|
|
58
63
|
- Script object literals always multi-line (even one property)
|
|
59
64
|
- Kebab-case tags (`u-button`, `un-card`)
|
|
60
65
|
- `v-if` / `v-for` on `<template>` wrappers — not on rendered nodes
|
|
61
|
-
- **2+ attributes → one per line
|
|
62
|
-
- `{{ ... }}` on its own line
|
|
66
|
+
- **2+ attributes → one per line** except **`u-modal`** (keep all `u-modal` attrs on one line); attribute order + default omissions (`variant="subtle"`, **Cancel only → `ghost`**, omit neutral `color`, `loading-auto`); non-self-closing `>` on same line as last attr; multi-line self-closing `/>` on its own line
|
|
67
|
+
- `{{ ... }}` on its own line (static + dynamic text may mix)
|
|
63
68
|
- `/* section */` comments; imports co-located under the section that uses them
|
|
64
69
|
- Light naming: `handleXxx` handlers, `it` in short callbacks, descriptive `for...of`, computeds use block + `return`
|
|
65
70
|
- Pages: explicit `definePageMeta.name`, reactive route params, named `navigateTo` / `nuxt-link` → [pages.md](references/pages.md)
|
|
@@ -139,6 +144,7 @@ From `nuxt.config.ts`: `@vueuse/nuxt`, `@nuxt/ui`, `@nuxtjs/i18n`; `ui.colorMode
|
|
|
139
144
|
| Utilities | `radXxx` → [radashi.md](references/radashi.md) |
|
|
140
145
|
| New page / route | [pages.md](references/pages.md) |
|
|
141
146
|
| List/detail fetch or mutation | [data-fetching.md](references/data-fetching.md) |
|
|
147
|
+
| New / custom resource | [resources.md](references/resources.md) |
|
|
142
148
|
| Formatting any of the above | [code-style.md](references/code-style.md) |
|
|
143
149
|
|
|
144
150
|
## Do / don’t
|
|
@@ -150,6 +156,7 @@ From `nuxt.config.ts`: `@vueuse/nuxt`, `@nuxt/ui`, `@nuxtjs/i18n`; `ui.colorMode
|
|
|
150
156
|
- Use field `identifier` for element kind; `type` only for HTML input types
|
|
151
157
|
- Handle dialog actions in `onClick`
|
|
152
158
|
- Follow code style for every generated file
|
|
159
|
+
- Resources: plugin → full REST set → dashboard nav / custom `<resource-manager>` page → [resources.md](references/resources.md)
|
|
153
160
|
|
|
154
161
|
**Don’t**
|
|
155
162
|
|
|
@@ -158,3 +165,4 @@ From `nuxt.config.ts`: `@vueuse/nuxt`, `@nuxt/ui`, `@nuxtjs/i18n`; `ui.colorMode
|
|
|
158
165
|
- Use PascalCase component tags in templates
|
|
159
166
|
- Set choice-button `value` unless the await result must distinguish buttons
|
|
160
167
|
- Assume color mode is enabled (layer disables it)
|
|
168
|
+
- Reimplement resource CRUD in route files (use `handleResource*`; customize via dedicated pages + domain APIs)
|
|
@@ -20,7 +20,7 @@ Write code so a reader can **scan vertically** and see structure before details.
|
|
|
20
20
|
Object/array literals in script are multi-line with trailing commas — even single-property objects passed to helpers (`toastSuccess`, `ufetch` options, etc.). Compact one-liners hide diffs and force horizontal reading.
|
|
21
21
|
|
|
22
22
|
4. **Templates are layout, not mini-scripts.**
|
|
23
|
-
Structural directives live on `<template>` wrappers so the rendered node stays a clean component/element. Attributes wrap predictably; closing `>` / `/>` placement is consistent; interpolations sit on their own line
|
|
23
|
+
Structural directives live on `<template>` wrappers so the rendered node stays a clean component/element. Attributes wrap predictably (`u-modal` stays one line); closing `>` / `/>` placement is consistent; interpolations sit on their own line (static + dynamic text may share one `{{ ... }}` or surrounding text).
|
|
24
24
|
|
|
25
25
|
5. **Section comments are the map.**
|
|
26
26
|
`/* section */` labels replace scavenger hunts through long `<script setup>` blocks. Imports sit next to the section that needs them, not in a hoisted pile at the top.
|
|
@@ -48,11 +48,49 @@ When editing an existing file, **absolute rules below always win**. For choices
|
|
|
48
48
|
| Component tags | lowercase kebab-case (`u-button`, `un-card`) — never PascalCase |
|
|
49
49
|
| Braces | always for `if` / `else` / `for` / `while` — no brace-less single-liners |
|
|
50
50
|
| `else` / `catch` | on their **own line** after `}` |
|
|
51
|
+
| `.js` / `.ts` file start | **two** blank lines at the top, **unless** the file starts with imports — then **no** blank lines before the first `import` |
|
|
51
52
|
|
|
52
53
|
---
|
|
53
54
|
|
|
54
55
|
## Vertical whitespace (script / TS)
|
|
55
56
|
|
|
57
|
+
### File start (`.js` / `.ts` only)
|
|
58
|
+
|
|
59
|
+
Start of every `.js` and `.ts` file must have **two blank lines**, except if it has imports at the start of the file — then put **no** blank lines before the first import.
|
|
60
|
+
|
|
61
|
+
```ts
|
|
62
|
+
// ✅ no imports — exactly two blank lines, then code
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
export default defineEventHandler(async event => {
|
|
66
|
+
...
|
|
67
|
+
});
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
// ✅ imports at start — import on line 1, no leading blanks
|
|
72
|
+
import { join } from 'node:path';
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
const { schema, type, inferred } = parseSchema({
|
|
76
|
+
...
|
|
77
|
+
});
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
```ts
|
|
81
|
+
// ❌ missing leading blanks when there are no imports
|
|
82
|
+
export default defineEventHandler(async event => {
|
|
83
|
+
...
|
|
84
|
+
});
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
```ts
|
|
88
|
+
// ❌ blank lines before the first import
|
|
89
|
+
import { join } from 'node:path';
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Vue SFCs are unchanged: `<script setup>` begins immediately inside the script block (no artificial leading blanks at the top of the `.vue` file).
|
|
93
|
+
|
|
56
94
|
### Section rhythm
|
|
57
95
|
|
|
58
96
|
- **Double blank line** between major boundaries: after `defineProps`/`defineEmits` blocks, between `/* section */` domains, before handler functions, between major async steps.
|
|
@@ -300,7 +338,8 @@ Keep tight `v-if` / `v-else` chains adjacent (no blank line between matching bra
|
|
|
300
338
|
### Attribute wrapping (hard rule)
|
|
301
339
|
|
|
302
340
|
- **0–1 attributes:** may stay on one line with the tag
|
|
303
|
-
- **2+ attributes:** one attribute per line
|
|
341
|
+
- **2+ attributes:** one attribute per line — **except `u-modal`**
|
|
342
|
+
- **`u-modal` only:** keep **all** attributes on the **same single line** as the tag (do not wrap), even when there are many
|
|
304
343
|
|
|
305
344
|
```vue
|
|
306
345
|
<!-- ✅ 0–1 attributes — inline OK -->
|
|
@@ -310,14 +349,12 @@ Keep tight `v-if` / `v-else` chains adjacent (no blank line between matching bra
|
|
|
310
349
|
</u-form-field>
|
|
311
350
|
<u-icon name="lucide:check" />
|
|
312
351
|
|
|
313
|
-
<!-- ✅
|
|
314
|
-
<u-modal
|
|
315
|
-
:ui="{ content: 'max-w-5xl' }"
|
|
316
|
-
scrollable
|
|
317
|
-
@update:open="!$event && emit('close')">
|
|
352
|
+
<!-- ✅ u-modal — always one line (exception) -->
|
|
353
|
+
<u-modal :ui="{ content: 'max-w-5xl' }" scrollable @update:open="!$event && emit('close')">
|
|
318
354
|
...
|
|
319
355
|
</u-modal>
|
|
320
356
|
|
|
357
|
+
<!-- ✅ other components — 2+ attributes, one per line -->
|
|
321
358
|
<u-button
|
|
322
359
|
variant="subtle"
|
|
323
360
|
icon="lucide:refresh-ccw"
|
|
@@ -350,11 +387,12 @@ Prefer defaults by **omitting** props rather than restating them:
|
|
|
350
387
|
|
|
351
388
|
| Component / context | Default convention |
|
|
352
389
|
|---------------------|--------------------|
|
|
353
|
-
| `u-button` | Prefer `variant="subtle"`
|
|
390
|
+
| `u-button` | Prefer `variant="subtle"` (or omit) for normal actions |
|
|
391
|
+
| Cancel buttons only | Use `variant="ghost"` / `variant: 'ghost'` — **only** for Cancel dismiss actions; do not use `ghost` on other buttons |
|
|
354
392
|
| Async `u-button` clicks | Prefer `loading-auto` over hand-rolled `isLoading` when nothing else depends on that flag |
|
|
355
393
|
| `u-badge` | Always `variant="subtle"`; use `icon` + `:label` (no default slot text); **do not** set `size`; **omit** `color` for neutral (use `undefined` in ternaries, never `color="neutral"`) |
|
|
356
394
|
| `u-tooltip` | Do not set `:delay-duration` — use the default delay |
|
|
357
|
-
| Action objects where subtle is the local default | Omit `variant: 'subtle'` unless overriding |
|
|
395
|
+
| Action objects where subtle is the local default | Omit `variant: 'subtle'` unless overriding; Cancel actions set `variant: 'ghost'` |
|
|
358
396
|
| Icons | Always `lucide:*` prefix |
|
|
359
397
|
|
|
360
398
|
```vue
|
|
@@ -417,12 +455,24 @@ Closing tags for block components (`</un-card>`, `</u-modal>`, …) always on th
|
|
|
417
455
|
|
|
418
456
|
### Text interpolation
|
|
419
457
|
|
|
420
|
-
Put `{{ ... }}` on its own line:
|
|
458
|
+
Put `{{ ... }}` on its own line (not glued onto the opening/closing tag). **Static + dynamic text may mix** in the same interpolation or around it — do not force template literals / split words solely to isolate dynamics:
|
|
421
459
|
|
|
422
460
|
```vue
|
|
423
461
|
<h1 class="text-2xl font-semibold">
|
|
424
462
|
Login
|
|
425
463
|
</h1>
|
|
464
|
+
|
|
465
|
+
<!-- ✅ static + dynamic together -->
|
|
466
|
+
<h1 class="text-2xl font-semibold">
|
|
467
|
+
Welcome, {{ user.name }}!
|
|
468
|
+
</h1>
|
|
469
|
+
|
|
470
|
+
<h2 class="mt-1">
|
|
471
|
+
{{ flashCardData?.category?.name }} - by {{ flashCardData?.owner?.name }}
|
|
472
|
+
</h2>
|
|
473
|
+
|
|
474
|
+
<!-- ❌ glued to tags -->
|
|
475
|
+
<h1 class="text-2xl font-semibold">{{ user.name }}</h1>
|
|
426
476
|
```
|
|
427
477
|
|
|
428
478
|
### Root structure
|
|
@@ -521,9 +571,11 @@ Pass handler **references** into action objects / watchers when possible (`onCli
|
|
|
521
571
|
|
|
522
572
|
## Server / plain TS files
|
|
523
573
|
|
|
524
|
-
Same whitespace, brace, literal, and call-formatting rules as script blocks:
|
|
574
|
+
Same whitespace, brace, literal, and call-formatting rules as script blocks. Honor the **file-start** rule (two leading blanks, or imports flush at line 1). Prefer `async event =>` style consistent with siblings:
|
|
525
575
|
|
|
526
576
|
```ts
|
|
577
|
+
|
|
578
|
+
|
|
527
579
|
export default defineEventHandler(async event => {
|
|
528
580
|
|
|
529
581
|
await assertRateLimit({
|
|
@@ -557,8 +609,6 @@ export default defineEventHandler(async event => {
|
|
|
557
609
|
});
|
|
558
610
|
```
|
|
559
611
|
|
|
560
|
-
Leading blank line at top of file is fine when the local tree uses it. Prefer `async event =>` style consistent with siblings.
|
|
561
|
-
|
|
562
612
|
---
|
|
563
613
|
|
|
564
614
|
## Anti-patterns (quick)
|
|
@@ -571,14 +621,18 @@ Leading blank line at top of file is fine when the local tree uses it. Prefer `a
|
|
|
571
621
|
| `if (!x) return;` | braced block |
|
|
572
622
|
| `} else {` | `}\nelse {` |
|
|
573
623
|
| `toastSuccess({ title: 'x' })` one-liner object | multi-line object + trailing comma |
|
|
574
|
-
| 3 attrs on one line | one attr per line |
|
|
624
|
+
| 3 attrs on one line (non-`u-modal`) | one attr per line |
|
|
625
|
+
| Multi-line `u-modal` attrs | keep `u-modal` attrs on one line |
|
|
575
626
|
| `>` on its own line after attrs | `>` after last attr |
|
|
576
|
-
| `{{ x }}` glued to tags | interpolation on its own line |
|
|
627
|
+
| `{{ x }}` glued to tags | interpolation on its own line (static + dynamic mix OK) |
|
|
628
|
+
| `ghost` on non-Cancel buttons | `ghost` only for Cancel |
|
|
577
629
|
| Hoisted import block | imports co-located under section |
|
|
578
630
|
| `computed(() => [ ... ])` | `computed(() => { return [ ... ]; })` |
|
|
579
631
|
| `color="neutral"` on badge | omit `color` / use `undefined` |
|
|
580
632
|
| `ufetch(\n url,\n {` | `ufetch(url, {` on one line |
|
|
581
633
|
| One-line `useUFetch(...)` | URL on next line; options multi-line |
|
|
634
|
+
| `.ts`/`.js` with no leading blanks (and no imports) | two blank lines at file start |
|
|
635
|
+
| Blank lines before first `import` | `import` on line 1 |
|
|
582
636
|
|
|
583
637
|
---
|
|
584
638
|
|
|
@@ -586,6 +640,7 @@ Leading blank line at top of file is fine when the local tree uses it. Prefer `a
|
|
|
586
640
|
|
|
587
641
|
- [ ] `<script setup>` without `lang="ts"`; no TS annotations in Vue
|
|
588
642
|
- [ ] 2-space indent; single quotes; semicolons; trailing commas in multi-line literals
|
|
643
|
+
- [ ] `.js`/`.ts`: two leading blank lines, or imports flush at line 1 (no blanks before first import)
|
|
589
644
|
- [ ] Double blanks between major sections; blank line before `</script>`; two blanks before `<template>`
|
|
590
645
|
- [ ] Non-trivial functions: blank after `{`, double blank between major steps, blank before `}`
|
|
591
646
|
- [ ] Tiny helpers stay tight
|
|
@@ -593,9 +648,9 @@ Leading blank line at top of file is fine when the local tree uses it. Prefer `a
|
|
|
593
648
|
- [ ] Script objects multi-line; template single-key objects may be inline
|
|
594
649
|
- [ ] Kebab-case component tags
|
|
595
650
|
- [ ] `v-if` / `v-for` on `<template>` wrappers
|
|
596
|
-
- [ ] 2+ attributes → one per line; `>` same line as last attr; multi-line self-closing `/>` on own line
|
|
597
|
-
- [ ] Attribute order + default-value omissions respected (`subtle`, no neutral color noise, `loading-auto`)
|
|
598
|
-
- [ ] `{{ }}` on own line
|
|
651
|
+
- [ ] 2+ attributes → one per line (**`u-modal` attrs stay on one line**); `>` same line as last attr; multi-line self-closing `/>` on own line
|
|
652
|
+
- [ ] Attribute order + default-value omissions respected (`subtle`, **Cancel → `ghost` only**, no neutral color noise, `loading-auto`)
|
|
653
|
+
- [ ] `{{ }}` on own line (static + dynamic mix OK)
|
|
599
654
|
- [ ] Section comments + import co-location where the file has sections
|
|
600
655
|
- [ ] `handleXxx` for action handlers; `it` for short callbacks; descriptive loop names
|
|
601
656
|
- [ ] Computeds that return structures use block + `return`
|
|
@@ -153,6 +153,14 @@ Avoid setting `value` on custom buttons unless the await result must distinguish
|
|
|
153
153
|
|
|
154
154
|
Action entries support `actionType: 'spacer'` (flex grow) and optional `tooltip`. Buttons use `loading-auto`.
|
|
155
155
|
|
|
156
|
+
Cancel / dismiss actions use `variant: 'ghost'` (or `variant="ghost"`). Do **not** use `ghost` on primary/submit/other actions — prefer omit / `subtle`.
|
|
157
|
+
|
|
158
|
+
Hand-rolled dialog shells keep **`u-modal` attributes on one line** (see [code-style.md](code-style.md)):
|
|
159
|
+
|
|
160
|
+
```vue
|
|
161
|
+
<u-modal :ui="{ content: 'max-w-5xl' }" scrollable @update:open="!$event && emit('close')">
|
|
162
|
+
```
|
|
163
|
+
|
|
156
164
|
## Do / don’t
|
|
157
165
|
|
|
158
166
|
**Do**
|
|
@@ -160,9 +168,12 @@ Action entries support `actionType: 'spacer'` (flex grow) and optional `tooltip`
|
|
|
160
168
|
- Prefer `launchFormPickerDialog` / `launchChoicePickerDialog` over hand-rolled `u-modal` for these flows
|
|
161
169
|
- Handle actions in button / submit `onClick`
|
|
162
170
|
- Keep field lists consistent with `un-form` (`identifier`, not `type`, for element kind)
|
|
171
|
+
- Mark Cancel with `variant: 'ghost'`; keep `u-modal` attrs on one line
|
|
163
172
|
|
|
164
173
|
**Don’t**
|
|
165
174
|
|
|
166
175
|
- Call `toast*` without `u-app` / toaster setup
|
|
167
176
|
- Set `value` on choice buttons by default — omit it unless needed
|
|
168
177
|
- Put primary dialog logic only after `await` when `onClick` should own it
|
|
178
|
+
- Use `ghost` on non-Cancel buttons
|
|
179
|
+
- Wrap `u-modal` attributes across multiple lines
|
|
@@ -0,0 +1,285 @@
|
|
|
1
|
+
# Unified resources
|
|
2
|
+
|
|
3
|
+
How CRUD **resources** are declared and consumed in apps built on this stack. Use this whenever adding or customizing a resource end-to-end.
|
|
4
|
+
|
|
5
|
+
## Mental model
|
|
6
|
+
|
|
7
|
+
A resource is one Mongo collection + typed schema + optional field meta, registered on a global `app` registry, exposed through a fixed REST file set, and managed in the dashboard via `<resource-manager>`.
|
|
8
|
+
|
|
9
|
+
| Layer | Role |
|
|
10
|
+
|-------|------|
|
|
11
|
+
| Nitro plugin (`*-resource.ts`) | `parseSchema` → augment `UnifiedAppRegistry` → `app.foo = { dbo: createUnifiedResourceController(...) }` |
|
|
12
|
+
| REST under `server/api/{kebab-plural}/` | Thin handlers calling `handleResource*` |
|
|
13
|
+
| Dashboard | Generic `[resourceName]` page, or a dedicated page wrapping `<resource-manager>` with extra actions |
|
|
14
|
+
|
|
15
|
+
Naming:
|
|
16
|
+
|
|
17
|
+
| Context | Shape | Example |
|
|
18
|
+
|---------|-------|---------|
|
|
19
|
+
| Registry / `dbo` / `handleResource*` `resource` | camelCase plural | `flashCards`, `authorizationRoles`, `users` |
|
|
20
|
+
| API folder + URL path | kebab-case plural | `flash-cards`, `authorization-roles`, `users` |
|
|
21
|
+
| Dashboard `resourceName` param | same as API path | `flash-cards` |
|
|
22
|
+
| Permissions (when used) | `admin.{kebab-plural}.{action}` | `admin.users.list`, `admin.flash-cards.create` |
|
|
23
|
+
|
|
24
|
+
Client helpers (`useResourceName`) derive:
|
|
25
|
+
|
|
26
|
+
- `resource` → Pascal singular (internal)
|
|
27
|
+
- `resourcePath` → kebab plural (API)
|
|
28
|
+
- `title` / `titlePlural` → display strings
|
|
29
|
+
|
|
30
|
+
Pass either camelCase or kebab-case into `<resource-manager resource="...">`; path/title conversion is handled for you. Prefer the name that matches the surrounding context (dashboard nav uses kebab; dedicated pages often pass camel like `users`).
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## 1. Declare in a server plugin
|
|
35
|
+
|
|
36
|
+
File: `server/plugins/{name}-resource.ts`
|
|
37
|
+
|
|
38
|
+
Pattern:
|
|
39
|
+
|
|
40
|
+
1. Two leading blank lines (no imports) **or** imports flush at line 1 — see [code-style.md](code-style.md).
|
|
41
|
+
2. `parseSchema({ ... })` → `{ schema, type, inferred }`.
|
|
42
|
+
3. `declare global { interface UnifiedAppRegistry { ... } }` so `app.resourceName` is typed.
|
|
43
|
+
4. `defineNitroPlugin` assigns `app.resourceName = { dbo: createUnifiedResourceController({ resource, schema, type, meta? }) }`.
|
|
44
|
+
|
|
45
|
+
Minimal example:
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
const { schema, type, inferred } = parseSchema({
|
|
51
|
+
'name': 'string',
|
|
52
|
+
'username': 'string',
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
declare global {
|
|
57
|
+
interface UnifiedAppRegistry {
|
|
58
|
+
users: {
|
|
59
|
+
dbo: UnifiedResourceController<typeof inferred>
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
export default defineNitroPlugin(() => {
|
|
66
|
+
app.users = {
|
|
67
|
+
dbo: createUnifiedResourceController({
|
|
68
|
+
resource: 'users',
|
|
69
|
+
schema,
|
|
70
|
+
type,
|
|
71
|
+
}),
|
|
72
|
+
};
|
|
73
|
+
});
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
With relations and UI meta:
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
createUnifiedResourceController({
|
|
80
|
+
resource: 'flashCards',
|
|
81
|
+
schema,
|
|
82
|
+
type,
|
|
83
|
+
meta: {
|
|
84
|
+
owner: {
|
|
85
|
+
resource: 'users',
|
|
86
|
+
},
|
|
87
|
+
category: {
|
|
88
|
+
resource: 'flashCardCategories',
|
|
89
|
+
},
|
|
90
|
+
description: {
|
|
91
|
+
hideInTable: true,
|
|
92
|
+
},
|
|
93
|
+
cards: {
|
|
94
|
+
children: {
|
|
95
|
+
backText: {
|
|
96
|
+
longText: true,
|
|
97
|
+
},
|
|
98
|
+
},
|
|
99
|
+
},
|
|
100
|
+
},
|
|
101
|
+
});
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Extra non-dbo fields on the registry entry are allowed (e.g. `app.media.directory` alongside `dbo`).
|
|
105
|
+
|
|
106
|
+
### Schema DSL (`parseSchema`)
|
|
107
|
+
|
|
108
|
+
Keys are field names; optional fields use a trailing `?` in the key (`'tags?'`, `'permissions?'`).
|
|
109
|
+
|
|
110
|
+
Common value shapes:
|
|
111
|
+
|
|
112
|
+
| Value | Meaning |
|
|
113
|
+
|-------|---------|
|
|
114
|
+
| `'string'`, `'number'`, `'boolean'` | Scalars |
|
|
115
|
+
| `'string[]'` | String array (tags UI) |
|
|
116
|
+
| `'Record<string, string>'` | String map |
|
|
117
|
+
| `[{ ...fields }, '[]']` | Array of nested objects (series UI) |
|
|
118
|
+
|
|
119
|
+
`createUnifiedResourceController` validates create/update with the compiled ArkType `type`, auto-adds `_id` / `createdAt` / nested `_id`s, and uses `resource` as the Mongo collection name.
|
|
120
|
+
|
|
121
|
+
### Field `meta` (drives schema API + forms + table)
|
|
122
|
+
|
|
123
|
+
| Meta | Effect |
|
|
124
|
+
|------|--------|
|
|
125
|
+
| `resource: 'otherResource'` | Relation: populate + form `identifier: 'resource'` (or `media` when target is `media`) |
|
|
126
|
+
| `hidden: true` | Omit from form fields |
|
|
127
|
+
| `hideInTable: true` | Omit from table columns (still in forms unless `hidden`) |
|
|
128
|
+
| `longText: true` | Textarea |
|
|
129
|
+
| `enum: [{ label, value }]` | Select |
|
|
130
|
+
| `labelFormat: '...'` | Date field |
|
|
131
|
+
| `width` | Form field width hint |
|
|
132
|
+
| `children: { ... }` | Nested meta for object-array item fields |
|
|
133
|
+
|
|
134
|
+
`GET .../schema` returns schema properties merged with this meta; the client maps that into form fields and columns via `useResourceMeta`.
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## 2. Standard REST routes
|
|
139
|
+
|
|
140
|
+
For each resource, add the full set under `server/api/{kebab-plural}/`:
|
|
141
|
+
|
|
142
|
+
| File | Handler | Typical permission suffix |
|
|
143
|
+
|------|---------|---------------------------|
|
|
144
|
+
| `schema.get.ts` | `handleResourceSchema` | `.schema` |
|
|
145
|
+
| `index.get.ts` | `handleResourceList` | `.list` |
|
|
146
|
+
| `index.post.ts` | `handleResourceCreate` | `.create` |
|
|
147
|
+
| `count.get.ts` | `handleResourceCount` | `.count` |
|
|
148
|
+
| `[resourceId].get.ts` | `handleResourceRetrieve` | `.retrieve` |
|
|
149
|
+
| `[resourceId].patch.ts` | `handleResourceUpdate` | `.update` |
|
|
150
|
+
| `[resourceId].delete.ts` | `handleResourceDelete` | `.delete` |
|
|
151
|
+
|
|
152
|
+
Every file is a thin wrapper:
|
|
153
|
+
|
|
154
|
+
```ts
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
export default defineEventHandler(async event => {
|
|
158
|
+
return handleResourceList({
|
|
159
|
+
resource: 'flashCards',
|
|
160
|
+
event,
|
|
161
|
+
permission: 'admin.flash-cards.list',
|
|
162
|
+
});
|
|
163
|
+
});
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
Rules:
|
|
167
|
+
|
|
168
|
+
- `resource` is always the **camelCase registry key**, not the folder name.
|
|
169
|
+
- `permission` is optional; omit when the route is open to any caller that already passed other gates, or when auth is handled elsewhere. Prefer consistent `admin.{kebab}.{action}` when protecting admin CRUD.
|
|
170
|
+
- Do not reimplement list/create/update logic in route files — extend via custom endpoints next to the resource (e.g. `/api/authentication/onboard-user`) when the default CRUD is not enough.
|
|
171
|
+
|
|
172
|
+
List query helpers (handled inside `handleResourceList` / siblings): `filter`, `select`, `sort`, `skip`, `limit`, `populate`, and `single=xtruex` for a single `find`.
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## 3. Dashboard: standard declaration
|
|
177
|
+
|
|
178
|
+
Generic page (one page for all standard resources):
|
|
179
|
+
|
|
180
|
+
```vue
|
|
181
|
+
<!-- pages/dashboard/resources/[resourceName].vue -->
|
|
182
|
+
definePageMeta({
|
|
183
|
+
name: 'dashboard.resources.single',
|
|
184
|
+
layout: 'dashboard',
|
|
185
|
+
middleware: ['is-authenticated'],
|
|
186
|
+
});
|
|
187
|
+
|
|
188
|
+
// template
|
|
189
|
+
<resource-manager :resource="resourceName" />
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
Nav links pass the **kebab API segment**:
|
|
193
|
+
|
|
194
|
+
```ts
|
|
195
|
+
{
|
|
196
|
+
label: 'Flash Cards',
|
|
197
|
+
to: {
|
|
198
|
+
name: 'dashboard.resources.single',
|
|
199
|
+
params: {
|
|
200
|
+
resourceName: 'flash-cards',
|
|
201
|
+
},
|
|
202
|
+
},
|
|
203
|
+
},
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
`<resource-manager>` provides Create / Refresh toolbar actions, table via `<resource-explorer-table>`, and per-row Edit / Delete dialogs wired to `/api/{resourcePath}`.
|
|
207
|
+
|
|
208
|
+
---
|
|
209
|
+
|
|
210
|
+
## 4. Dashboard: customize (users pattern)
|
|
211
|
+
|
|
212
|
+
When default Create/Edit is wrong for the domain, **do not** overload the generic `[resourceName]` page. Add a dedicated page that still uses `<resource-manager>` but supplies extra actions.
|
|
213
|
+
|
|
214
|
+
Example: `pages/resources/users.vue` (named route, not necessarily under `dashboard/resources/`):
|
|
215
|
+
|
|
216
|
+
```vue
|
|
217
|
+
definePageMeta({
|
|
218
|
+
name: 'dashboard.resources.users',
|
|
219
|
+
layout: 'dashboard',
|
|
220
|
+
middleware: ['is-authenticated'],
|
|
221
|
+
});
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
const resourceManagerEl = useTemplateRef('resourceManager');
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
// custom handlers → domain APIs (onboard, reset-password, …)
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<template>
|
|
231
|
+
<resource-manager
|
|
232
|
+
ref="resourceManager"
|
|
233
|
+
resource="users"
|
|
234
|
+
:actions="[
|
|
235
|
+
{
|
|
236
|
+
variant: 'subtle',
|
|
237
|
+
icon: 'lucide:user-plus',
|
|
238
|
+
label: 'Onboard User',
|
|
239
|
+
onClick: handleOnboardUser,
|
|
240
|
+
},
|
|
241
|
+
]"
|
|
242
|
+
:resource-actions="[
|
|
243
|
+
{
|
|
244
|
+
icon: 'lucide:key-round',
|
|
245
|
+
tooltip: 'Reset Password',
|
|
246
|
+
onClick: handleResetPassword,
|
|
247
|
+
},
|
|
248
|
+
]"
|
|
249
|
+
/>
|
|
250
|
+
</template>
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
Customization knobs on `<resource-manager>`:
|
|
254
|
+
|
|
255
|
+
| Prop | Placement | Merge order |
|
|
256
|
+
|------|-----------|-------------|
|
|
257
|
+
| `actions` | Card toolbar | After default **Create**, before **Refresh** |
|
|
258
|
+
| `resourceActions` | Per-row table actions | Before default **Edit** / **Delete** |
|
|
259
|
+
| `ref` → `refreshResources()` | After custom mutations | Call so the table reloads |
|
|
260
|
+
|
|
261
|
+
Point nav at the custom named route instead of `dashboard.resources.single`:
|
|
262
|
+
|
|
263
|
+
```ts
|
|
264
|
+
to: {
|
|
265
|
+
name: 'dashboard.resources.users',
|
|
266
|
+
},
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
Custom handlers typically:
|
|
270
|
+
|
|
271
|
+
1. `launchFormPickerDialog` / `launchChoicePickerDialog` with explicit `fields`
|
|
272
|
+
2. `ufetch` to a **domain** endpoint (not necessarily the generic resource CRUD)
|
|
273
|
+
3. `await resourceManagerEl.value?.refreshResources()`
|
|
274
|
+
4. `toastSuccess` / `toastError`
|
|
275
|
+
|
|
276
|
+
Keep the standard REST resource routes even when the UI is customized — other tools and the generic schema/list still depend on them.
|
|
277
|
+
|
|
278
|
+
---
|
|
279
|
+
|
|
280
|
+
## Checklist: new resource
|
|
281
|
+
|
|
282
|
+
- [ ] `server/plugins/{name}-resource.ts` — schema, registry, `createUnifiedResourceController`, meta for relations/UI
|
|
283
|
+
- [ ] Full `server/api/{kebab-plural}/` route set with camelCase `resource` (+ permissions if admin)
|
|
284
|
+
- [ ] Dashboard: nav → `dashboard.resources.single` + kebab `resourceName`, **or** dedicated page + `actions` / `resource-actions`
|
|
285
|
+
- [ ] Follow [code-style.md](code-style.md) (including file-start blank lines)
|