@astram/guide 0.2.2 → 0.2.4
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/CAPABILITIES.md +5 -2
- package/FRAMEWORK_RULES.md +12 -0
- package/package.json +1 -1
package/CAPABILITIES.md
CHANGED
|
@@ -140,8 +140,11 @@ imports: [
|
|
|
140
140
|
`readScope` declares the subtree wall; `create: 'unscoped'` opts a type out of the create wall.
|
|
141
141
|
- **Physical wall** — the raw DB pool is sealed in the engine. The scaffold's
|
|
142
142
|
`server/eslint.config.mjs` fails lint on driver imports, raw pools, `.query()` and the
|
|
143
|
-
framework's internal DB exports anywhere in `src/**` except `app.module.ts` and `main.ts
|
|
144
|
-
|
|
143
|
+
framework's internal DB exports anywhere in `src/**` except `app.module.ts` and `main.ts`, and on
|
|
144
|
+
uuid-named route/body inputs read without `UuidPipe` / `uuidField` (`@astram/guard`). A lint
|
|
145
|
+
rule is a backstop, not a sandbox: do not go around it. The uuid check matches names only
|
|
146
|
+
(`id`, `uuid`, `…Id(s)`, `…Uuid(s)`): it is a nudge, not a guarantee, so put `UuidPipe` on
|
|
147
|
+
every uuid route param and a uuid helper on every uuid body/query field whatever its name.
|
|
145
148
|
- **Gap signal** — an unsupported field type or operation throws `CapabilityNotSupportedError`
|
|
146
149
|
(a Rule-4 STOP). Field types this version: `string`, `number`, `boolean`, `uuid`, `timestamp`,
|
|
147
150
|
`json`.
|
package/FRAMEWORK_RULES.md
CHANGED
|
@@ -71,6 +71,18 @@ app refuses to boot with one — a forgotten declaration locks the door instead
|
|
|
71
71
|
silently exposing it. Never make a route public to "make it work"; classify it
|
|
72
72
|
correctly.
|
|
73
73
|
|
|
74
|
+
**Validate uuid inputs at the edge.** Every uuid route param uses `UuidPipe`
|
|
75
|
+
(`@Param('uuid', UuidPipe)`) and every uuid body or query field goes through
|
|
76
|
+
`uuidField` / `optionalUuidField` / `uuidArrayField` (all from `@astram/guard`). They
|
|
77
|
+
answer 400 for anything that is not a strict uuid and hand you the canonical lower-case
|
|
78
|
+
form. The database matches uuids ignoring case, trailing spaces and character width, so
|
|
79
|
+
a raw `"<id> "` reaches the row while your exact checks in code miss it. The lint wall
|
|
80
|
+
flags uuid-named inputs (`id`, `uuid`, `…Id(s)`, `…Uuid(s)`) read without them, but it is a
|
|
81
|
+
name-based nudge, not a guarantee: a uuid under another name (`@Param('target')`), a
|
|
82
|
+
destructured body, a body bound to another variable name, a value read off `req` or a param
|
|
83
|
+
given any other pipe passes lint unchecked. Apply the
|
|
84
|
+
pipe or helper to every uuid input whatever its name; a clean lint run proves nothing more.
|
|
85
|
+
|
|
74
86
|
## 4. When the framework can't do it: STOP and FLAG the gap — do NOT work around it
|
|
75
87
|
|
|
76
88
|
This is the most important rule. When a feature needs a capability the framework does
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@astram/guide",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "Astram framework — the AI/dev GUIDE layer (ADR-0025). Ships the framework's hard rules + capabilities manifest as installed, upgrade-refreshed docs. A consumer app's CLAUDE.md references FRAMEWORK_RULES.md from this package; `npm update` replaces it wholesale so new rules arrive cleanly, while the app's own .astram/guide/ layer is never touched. This is the framework-owned FLOOR: an app rule may tighten it, never weaken it.",
|
|
6
6
|
"type": "commonjs",
|