@transitrix/diagrams 1.0.0 → 1.1.0
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/LICENSE +21 -21
- package/README.md +47 -47
- package/dist/__tests__/edge-path.test.js +8 -0
- package/dist/activities/cpm.js +11 -2
- package/dist/activities/gantt.js +6 -3
- package/dist/activities/types.d.ts +1 -0
- package/dist/activities/validate.js +3 -3
- package/dist/activity-card/__tests__/example.test.js +20 -1
- package/dist/activity-card/__tests__/layout.test.js +102 -11
- package/dist/activity-card/__tests__/resolver.test.js +161 -7
- package/dist/activity-card/index.d.ts +1 -1
- package/dist/activity-card/layout.d.ts +1 -1
- package/dist/activity-card/layout.js +220 -103
- package/dist/activity-card/resolver.js +115 -28
- package/dist/activity-card/types.d.ts +150 -27
- package/dist/activity-card/validate.js +3 -0
- package/dist/actor/__tests__/validate.test.js +63 -31
- package/dist/actor/index.d.ts +1 -1
- package/dist/actor/index.js +1 -1
- package/dist/actor/types.d.ts +7 -3
- package/dist/actor/types.js +17 -3
- package/dist/actor/validate.js +55 -26
- package/dist/assertion/types.d.ts +3 -1
- package/dist/assertion/types.js +1 -1
- package/dist/change/__tests__/validate.test.js +40 -34
- package/dist/change/index.d.ts +1 -0
- package/dist/change/types.d.ts +1 -1
- package/dist/change/types.js +2 -2
- package/dist/change/validate.d.ts +6 -1
- package/dist/change/validate.js +68 -41
- package/dist/compliance/__tests__/classify.test.js +34 -0
- package/dist/compliance/__tests__/coverage-metric.test.js +146 -46
- package/dist/compliance/__tests__/html.test.js +2 -2
- package/dist/compliance/__tests__/impact.test.js +509 -6
- package/dist/compliance/classify.d.ts +6 -0
- package/dist/compliance/classify.js +9 -1
- package/dist/compliance/coverage-metric.d.ts +31 -11
- package/dist/compliance/coverage-metric.js +149 -39
- package/dist/compliance/html.js +78 -81
- package/dist/compliance/impact.d.ts +100 -16
- package/dist/compliance/impact.js +272 -28
- package/dist/compliance/index.d.ts +2 -2
- package/dist/compliance/index.js +1 -1
- package/dist/compliance/markdown.js +1 -0
- package/dist/compliance/types.d.ts +25 -6
- package/dist/edge-path.d.ts +8 -4
- package/dist/edge-path.js +11 -6
- package/dist/factor/__tests__/validate.test.js +75 -46
- package/dist/factor/index.d.ts +3 -2
- package/dist/factor/index.js +1 -1
- package/dist/factor/types.d.ts +5 -8
- package/dist/factor/types.js +10 -5
- package/dist/factor/validate.d.ts +6 -1
- package/dist/factor/validate.js +68 -50
- package/dist/fgca/__tests__/chain-table.test.js +2 -2
- package/dist/fgca/__tests__/layout.test.js +11 -11
- package/dist/fgca/__tests__/preview-layout.test.js +7 -7
- package/dist/fgca/__tests__/resolver.test.js +185 -0
- package/dist/fgca/chain-table.d.ts +1 -1
- package/dist/fgca/chain-table.js +4 -4
- package/dist/fgca/index.d.ts +4 -2
- package/dist/fgca/index.js +2 -1
- package/dist/fgca/layout.d.ts +2 -2
- package/dist/fgca/layout.js +9 -9
- package/dist/fgca/nodeTypes.d.ts +1 -1
- package/dist/fgca/nodeTypes.js +2 -2
- package/dist/fgca/nodes/FGCAFactorNode.d.ts +3 -3
- package/dist/fgca/nodes/FGCAFactorNode.js +5 -5
- package/dist/fgca/parse-canonical.js +15 -10
- package/dist/fgca/preview-layout.d.ts +1 -1
- package/dist/fgca/preview-layout.js +4 -4
- package/dist/fgca/resolver.d.ts +49 -0
- package/dist/fgca/resolver.js +126 -0
- package/dist/fgca/types.d.ts +11 -11
- package/dist/fgca/types.js +2 -2
- package/dist/fgca/validate.d.ts +2 -2
- package/dist/fgca/validate.js +17 -14
- package/dist/goals/index.d.ts +1 -1
- package/dist/index.d.ts +5 -0
- package/dist/index.js +5 -0
- package/dist/process-blueprint/__tests__/layout.test.js +37 -0
- package/dist/process-blueprint/index.d.ts +1 -1
- package/dist/process-blueprint/layout.js +66 -35
- package/dist/process-blueprint/types.d.ts +36 -1
- package/dist/scenarios/index.d.ts +1 -1
- package/dist/scenarios/types.d.ts +4 -4
- package/dist/stakeholder/__tests__/validate.test.js +49 -47
- package/dist/stakeholder/index.d.ts +1 -0
- package/dist/stakeholder/types.d.ts +3 -4
- package/dist/stakeholder/types.js +2 -3
- package/dist/stakeholder/validate.d.ts +6 -1
- package/dist/stakeholder/validate.js +71 -50
- package/dist/target-state/__tests__/validate.test.js +43 -27
- package/dist/target-state/index.d.ts +2 -0
- package/dist/target-state/index.js +1 -0
- package/dist/target-state/types.d.ts +6 -1
- package/dist/target-state/types.js +8 -7
- package/dist/target-state/validate.d.ts +6 -1
- package/dist/target-state/validate.js +69 -45
- package/dist/theme/themes.js +71 -69
- package/dist/theme/tokens.d.ts +7 -1
- package/dist/theme/tokens.js +3 -1
- package/dist/webview/__tests__/entry-notations.test.js +2 -0
- package/dist/webview/__tests__/entry.test.js +11 -11
- package/dist/webview/__tests__/render-process.test.js +463 -0
- package/dist/webview/__tests__/render-util.test.d.ts +1 -0
- package/dist/webview/__tests__/render-util.test.js +54 -0
- package/dist/webview/entry.d.ts +1 -1
- package/dist/webview/entry.js +9 -5
- package/dist/webview/render-activities.d.ts +24 -2
- package/dist/webview/render-activities.js +92 -57
- package/dist/webview/render-activity-card.d.ts +11 -1
- package/dist/webview/render-activity-card.js +115 -79
- package/dist/webview/render-blocks.d.ts +24 -1
- package/dist/webview/render-blocks.js +58 -24
- package/dist/webview/render-fgca.d.ts +31 -0
- package/dist/webview/render-fgca.js +30 -19
- package/dist/webview/render-goals.d.ts +27 -1
- package/dist/webview/render-goals.js +42 -32
- package/dist/webview/render-process-blueprint.d.ts +11 -1
- package/dist/webview/render-process-blueprint.js +118 -53
- package/dist/webview/render-process.d.ts +95 -0
- package/dist/webview/render-process.js +392 -0
- package/dist/webview/render-scenarios.js +2 -2
- package/dist/webview/render-util.d.ts +19 -6
- package/dist/webview/render-util.js +23 -15
- package/package.json +54 -40
- package/src/__tests__/edge-path.test.ts +58 -46
- package/src/__tests__/scope.test.ts +27 -27
- package/src/__tests__/yaml-normalize.test.ts +158 -158
- package/src/activities/__tests__/cpm.test.ts +164 -164
- package/src/activities/__tests__/gantt.test.ts +245 -245
- package/src/activities/__tests__/layout.test.ts +112 -112
- package/src/activities/__tests__/validate.test.ts +409 -409
- package/src/activities/cpm.ts +107 -95
- package/src/activities/gantt.ts +277 -276
- package/src/activities/index.ts +28 -28
- package/src/activities/layout.ts +112 -112
- package/src/activities/types.ts +149 -148
- package/src/activities/validate.ts +357 -357
- package/src/activity-card/__tests__/example.test.ts +85 -66
- package/src/activity-card/__tests__/layout.test.ts +169 -63
- package/src/activity-card/__tests__/resolver.test.ts +330 -161
- package/src/activity-card/__tests__/validate.test.ts +131 -131
- package/src/activity-card/index.ts +38 -32
- package/src/activity-card/layout.ts +324 -194
- package/src/activity-card/resolver.ts +422 -337
- package/src/activity-card/types.ts +376 -237
- package/src/activity-card/validate.ts +162 -158
- package/src/actor/__tests__/validate.test.ts +70 -31
- package/src/actor/index.ts +1 -1
- package/src/actor/types.ts +21 -7
- package/src/actor/validate.ts +59 -27
- package/src/applications/__tests__/validate.test.ts +256 -256
- package/src/applications/index.ts +11 -11
- package/src/applications/types.ts +43 -43
- package/src/applications/validate.ts +131 -131
- package/src/assertion/__tests__/example.test.ts +37 -37
- package/src/assertion/__tests__/validate.test.ts +142 -142
- package/src/assertion/index.ts +12 -12
- package/src/assertion/types.ts +60 -58
- package/src/assertion/validate.ts +145 -145
- package/src/blocks/__tests__/layout.test.ts +169 -169
- package/src/blocks/__tests__/validate.test.ts +260 -260
- package/src/blocks/index.ts +17 -17
- package/src/blocks/layout.ts +186 -186
- package/src/blocks/types.ts +62 -62
- package/src/blocks/validate.ts +206 -206
- package/src/capability-map/__tests__/validate.test.ts +238 -238
- package/src/capability-map/index.ts +8 -8
- package/src/capability-map/types.ts +29 -29
- package/src/capability-map/validate.ts +127 -127
- package/src/change/__tests__/validate.test.ts +43 -34
- package/src/change/index.ts +1 -0
- package/src/change/types.ts +5 -3
- package/src/change/validate.ts +75 -43
- package/src/compliance/__tests__/classify.test.ts +64 -27
- package/src/compliance/__tests__/confidence.test.ts +98 -98
- package/src/compliance/__tests__/coverage-metric.test.ts +300 -188
- package/src/compliance/__tests__/demo-scenario.test.ts +273 -273
- package/src/compliance/__tests__/example.test.ts +57 -57
- package/src/compliance/__tests__/gap-report.test.ts +128 -128
- package/src/compliance/__tests__/html.test.ts +141 -141
- package/src/compliance/__tests__/impact.test.ts +1059 -481
- package/src/compliance/__tests__/markdown.test.ts +94 -94
- package/src/compliance/__tests__/views.test.ts +64 -64
- package/src/compliance/classify.ts +100 -84
- package/src/compliance/confidence.ts +69 -69
- package/src/compliance/coverage-metric.ts +404 -263
- package/src/compliance/gap-report.ts +94 -94
- package/src/compliance/html.ts +291 -295
- package/src/compliance/impact.ts +979 -677
- package/src/compliance/index.ts +57 -56
- package/src/compliance/markdown.ts +136 -135
- package/src/compliance/reverse-index.ts +33 -33
- package/src/compliance/types.ts +136 -120
- package/src/compliance/views.ts +46 -46
- package/src/compliance-matrix/__tests__/build.test.ts +200 -200
- package/src/compliance-matrix/__tests__/example.test.ts +57 -57
- package/src/compliance-matrix/index.ts +11 -11
- package/src/compliance-matrix/types.ts +102 -102
- package/src/edge-path.ts +50 -44
- package/src/factor/__tests__/validate.test.ts +81 -46
- package/src/factor/index.ts +3 -7
- package/src/factor/types.ts +15 -19
- package/src/factor/validate.ts +77 -51
- package/src/fgca/__tests__/chain-table.test.ts +172 -172
- package/src/fgca/__tests__/layout.test.ts +179 -179
- package/src/fgca/__tests__/parse-canonical.test.ts +248 -248
- package/src/fgca/__tests__/preview-layout.test.ts +124 -124
- package/src/fgca/__tests__/resolver.test.ts +209 -0
- package/src/fgca/__tests__/validate.test.ts +142 -142
- package/src/fgca/chain-table.ts +225 -225
- package/src/fgca/index.ts +47 -45
- package/src/fgca/layout.ts +204 -204
- package/src/fgca/nodeTypes.ts +11 -11
- package/src/fgca/nodes/FGCAActivityNode.tsx +65 -65
- package/src/fgca/nodes/FGCAChangeNode.tsx +64 -64
- package/src/fgca/nodes/FGCAFactorNode.tsx +64 -64
- package/src/fgca/nodes/FGCAGoalNode.tsx +72 -72
- package/src/fgca/parse-canonical.ts +405 -400
- package/src/fgca/preview-layout.ts +217 -217
- package/src/fgca/resolver.ts +159 -0
- package/src/fgca/types.ts +50 -50
- package/src/fgca/validate.ts +129 -126
- package/src/geometry.ts +9 -9
- package/src/goals/__tests__/layout.test.ts +175 -175
- package/src/goals/__tests__/mutations.test.ts +111 -111
- package/src/goals/__tests__/parse-canonical.test.ts +145 -145
- package/src/goals/__tests__/validate.test.ts +202 -202
- package/src/goals/index.ts +20 -21
- package/src/goals/layout.ts +172 -172
- package/src/goals/mutations.ts +123 -123
- package/src/goals/parse-canonical.ts +286 -286
- package/src/goals/types.ts +85 -85
- package/src/goals/validate.ts +136 -136
- package/src/index.ts +28 -23
- package/src/process-blueprint/__tests__/compliance-lane.test.ts +320 -320
- package/src/process-blueprint/__tests__/layout.test.ts +240 -195
- package/src/process-blueprint/__tests__/validate.test.ts +310 -310
- package/src/process-blueprint/index.ts +32 -31
- package/src/process-blueprint/layout.ts +564 -531
- package/src/process-blueprint/types.ts +278 -242
- package/src/process-blueprint/validate.ts +181 -181
- package/src/process-map/__tests__/validate.test.ts +223 -223
- package/src/process-map/index.ts +10 -10
- package/src/process-map/types.ts +36 -36
- package/src/process-map/validate.ts +135 -135
- package/src/products/__tests__/validate.test.ts +239 -239
- package/src/products/index.ts +9 -9
- package/src/products/types.ts +31 -31
- package/src/products/validate.ts +112 -112
- package/src/repo-validate/__tests__/validate-repo.test.ts +149 -149
- package/src/repo-validate/index.ts +2 -2
- package/src/repo-validate/types.ts +50 -50
- package/src/repo-validate/validate-repo.ts +196 -196
- package/src/requirement/__tests__/example.test.ts +24 -24
- package/src/requirement/__tests__/validate.test.ts +96 -96
- package/src/requirement/index.ts +4 -4
- package/src/requirement/types.ts +35 -35
- package/src/requirement/validate.ts +92 -92
- package/src/scenarios/__tests__/validate.test.ts +209 -209
- package/src/scenarios/index.ts +15 -15
- package/src/scenarios/types.ts +37 -37
- package/src/scenarios/validate.ts +122 -122
- package/src/schema-version.ts +16 -16
- package/src/scope.ts +46 -46
- package/src/stakeholder/__tests__/validate.test.ts +51 -47
- package/src/stakeholder/index.ts +1 -0
- package/src/stakeholder/types.ts +7 -7
- package/src/stakeholder/validate.ts +79 -52
- package/src/target-state/__tests__/validate.test.ts +48 -27
- package/src/target-state/index.ts +2 -0
- package/src/target-state/types.ts +11 -7
- package/src/target-state/validate.ts +76 -46
- package/src/theme/index.ts +4 -4
- package/src/theme/themes.ts +239 -237
- package/src/theme/tokens.ts +135 -133
- package/src/typed-id.ts +56 -56
- package/src/validation-types.ts +36 -36
- package/src/webview/__tests__/entry-notations.test.ts +79 -77
- package/src/webview/__tests__/entry.test.ts +64 -64
- package/src/webview/__tests__/render-goals.test.ts +72 -72
- package/src/webview/__tests__/render-process.test.ts +538 -0
- package/src/webview/__tests__/render-util.test.ts +66 -0
- package/src/webview/entry.ts +298 -292
- package/src/webview/render-activities.ts +111 -69
- package/src/webview/render-activity-card.ts +275 -234
- package/src/webview/render-blocks.ts +78 -28
- package/src/webview/render-fgca.ts +53 -28
- package/src/webview/render-goals.ts +133 -110
- package/src/webview/render-process-blueprint.ts +281 -207
- package/src/webview/render-process.ts +507 -0
- package/src/webview/render-scenarios.ts +3 -3
- package/src/webview/render-util.ts +27 -14
- package/src/webview/styles.css +322 -323
- package/src/yaml-normalize.ts +56 -56
- package/dist/element-envelope.d.ts +0 -15
- package/dist/element-envelope.js +0 -55
- package/dist/issues/__tests__/layout.test.js +0 -62
- package/dist/issues/__tests__/validate.test.js +0 -82
- package/dist/issues/index.d.ts +0 -4
- package/dist/issues/index.js +0 -2
- package/dist/issues/layout.d.ts +0 -10
- package/dist/issues/layout.js +0 -82
- package/dist/issues/types.d.ts +0 -61
- package/dist/issues/types.js +0 -6
- package/dist/issues/validate.d.ts +0 -3
- package/dist/issues/validate.js +0 -143
- package/dist/webview/transitrix-render.css +0 -323
- package/dist/webview/transitrix-render.js +0 -6452
- package/dist/webview/transitrix-render.js.map +0 -7
- package/src/element-envelope.ts +0 -76
- /package/dist/{issues/__tests__/layout.test.d.ts → fgca/__tests__/resolver.test.d.ts} +0 -0
- /package/dist/{issues/__tests__/validate.test.d.ts → webview/__tests__/render-process.test.d.ts} +0 -0
|
@@ -1,196 +1,196 @@
|
|
|
1
|
-
// Repo-scope validator (vkgeorgia/transitrix-studio#141).
|
|
2
|
-
//
|
|
3
|
-
// Pure port of the whole-repo checks owned by the methodology's
|
|
4
|
-
// `.validators/lint.py`, run over the shared TypeScript model instead of Python.
|
|
5
|
-
// Parity reference: the `acme_corp` worked example, which `lint.py` passes with
|
|
6
|
-
// zero findings — this validator must also produce zero findings on it.
|
|
7
|
-
//
|
|
8
|
-
// Ported checks (mirroring lint.py's phases):
|
|
9
|
-
// 1. YAML syntax (phase 1) — unparseable canon file -> finding.
|
|
10
|
-
// 2. ID uniqueness — same `id` defined in >1 file -> finding.
|
|
11
|
-
// (lint.py silently last-wins; we surface it,
|
|
12
|
-
// but acme_corp has no duplicates, so parity
|
|
13
|
-
// holds on the reference fixture.)
|
|
14
|
-
// 3. Atomicity (phase 3) — element file carrying a `relations:` key.
|
|
15
|
-
// 4. Referential integ. (phase 4) — relation endpoint not resolving to a known
|
|
16
|
-
// element id. We resolve the canonical
|
|
17
|
-
// `from`/`to` keys (the real relation schema)
|
|
18
|
-
// and also accept lint.py's `source`/`target`.
|
|
19
|
-
// 5. Semantic rules (phase 5) — ArchiMate layer-semantics. lint.py ships
|
|
20
|
-
// this as a no-op stub; ported faithfully as a
|
|
21
|
-
// no-op (see `checkLayerSemantics`). Deferred
|
|
22
|
-
// until the methodology defines the rules.
|
|
23
|
-
// 6. Policy (phase 6) — element marked Active/Production with no
|
|
24
|
-
// owner.
|
|
25
|
-
//
|
|
26
|
-
// Findings stay `{ scope, id, message }` — no severity, no target/category
|
|
27
|
-
// taxonomy (deferred per the ADR).
|
|
28
|
-
|
|
29
|
-
import type { RepoDoc, RepoFinding, RepoModelInput } from './types.js';
|
|
30
|
-
|
|
31
|
-
const PScope: RepoFinding['scope'] = 'repo';
|
|
32
|
-
|
|
33
|
-
/** Statuses that, per lint.py's policy check, require an owner. */
|
|
34
|
-
const OWNER_REQUIRED_STATUSES = new Set(['Active', 'Production']);
|
|
35
|
-
|
|
36
|
-
function isRecord(v: unknown): v is Record<string, unknown> {
|
|
37
|
-
return typeof v === 'object' && v !== null && !Array.isArray(v);
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
/** Read a string `id` from a parsed doc, or `null` if absent/non-string.
|
|
41
|
-
* Mirrors lint.py, which only treats a doc as an element/relation when it has
|
|
42
|
-
* a top-level `id` (sidecars such as versioned-attribute files have no `id`
|
|
43
|
-
* and are ignored). */
|
|
44
|
-
function docId(doc: RepoDoc): string | null {
|
|
45
|
-
if (!doc.data) return null;
|
|
46
|
-
const id = doc.data['id'];
|
|
47
|
-
return typeof id === 'string' && id.length > 0 ? id : null;
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
/** Resolve a relation endpoint, which may be a bare id string or a `{ id }`
|
|
51
|
-
* mapping (lint.py accepts both). Returns the id string or `null`. */
|
|
52
|
-
function endpointId(value: unknown): string | null {
|
|
53
|
-
if (typeof value === 'string') return value.length > 0 ? value : null;
|
|
54
|
-
if (isRecord(value)) {
|
|
55
|
-
const id = value['id'];
|
|
56
|
-
if (typeof id === 'string' && id.length > 0) return id;
|
|
57
|
-
}
|
|
58
|
-
return null;
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
/** Phase 1 — unparseable canon files surface as findings. */
|
|
62
|
-
function checkSyntax(docs: RepoDoc[], findings: RepoFinding[]): void {
|
|
63
|
-
for (const doc of docs) {
|
|
64
|
-
if (doc.parseError) {
|
|
65
|
-
findings.push({
|
|
66
|
-
scope: PScope,
|
|
67
|
-
id: '',
|
|
68
|
-
message: `YAML syntax error in ${doc.path}: ${doc.parseError}`,
|
|
69
|
-
});
|
|
70
|
-
}
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
/** Phase 2 (as a check) — the same id defined in more than one file. */
|
|
75
|
-
function checkIdUniqueness(input: RepoModelInput, findings: RepoFinding[]): void {
|
|
76
|
-
const filesById = new Map<string, string[]>();
|
|
77
|
-
for (const doc of [...input.elements, ...input.relations]) {
|
|
78
|
-
const id = docId(doc);
|
|
79
|
-
if (!id) continue;
|
|
80
|
-
const list = filesById.get(id);
|
|
81
|
-
if (list) list.push(doc.path);
|
|
82
|
-
else filesById.set(id, [doc.path]);
|
|
83
|
-
}
|
|
84
|
-
for (const [id, files] of filesById) {
|
|
85
|
-
if (files.length > 1) {
|
|
86
|
-
findings.push({
|
|
87
|
-
scope: PScope,
|
|
88
|
-
id,
|
|
89
|
-
message: `Duplicate id '${id}' defined in ${files.length} files: ${files.join(', ')}`,
|
|
90
|
-
});
|
|
91
|
-
}
|
|
92
|
-
}
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
/** Phase 3 — relations must live in their own files, not inline on elements. */
|
|
96
|
-
function checkAtomicity(input: RepoModelInput, findings: RepoFinding[]): void {
|
|
97
|
-
for (const doc of input.elements) {
|
|
98
|
-
const id = docId(doc);
|
|
99
|
-
if (id && doc.data && 'relations' in doc.data) {
|
|
100
|
-
findings.push({
|
|
101
|
-
scope: PScope,
|
|
102
|
-
id,
|
|
103
|
-
message:
|
|
104
|
-
`Atomicity violation: element '${id}' (${doc.path}) contains a ` +
|
|
105
|
-
`'relations' section. Move relations to separate files under canon/relations/.`,
|
|
106
|
-
});
|
|
107
|
-
}
|
|
108
|
-
}
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
/** Phase 4 — every relation endpoint must resolve to a known element id. */
|
|
112
|
-
function checkReferentialIntegrity(input: RepoModelInput, findings: RepoFinding[]): void {
|
|
113
|
-
const elementIds = new Set<string>();
|
|
114
|
-
for (const doc of input.elements) {
|
|
115
|
-
const id = docId(doc);
|
|
116
|
-
if (id) elementIds.add(id);
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
for (const doc of input.relations) {
|
|
120
|
-
if (!doc.data) continue;
|
|
121
|
-
const relId = docId(doc) ?? '';
|
|
122
|
-
// Canonical relation schema uses `from`/`to`; `source`/`target` accepted for
|
|
123
|
-
// lint.py compatibility.
|
|
124
|
-
const fromId = endpointId(doc.data['from']) ?? endpointId(doc.data['source']);
|
|
125
|
-
const toId = endpointId(doc.data['to']) ?? endpointId(doc.data['target']);
|
|
126
|
-
|
|
127
|
-
if (fromId && !elementIds.has(fromId)) {
|
|
128
|
-
findings.push({
|
|
129
|
-
scope: PScope,
|
|
130
|
-
id: relId,
|
|
131
|
-
message: `Referential integrity: relation '${relId || doc.path}' endpoint '${fromId}' (from) does not resolve to a known element.`,
|
|
132
|
-
});
|
|
133
|
-
}
|
|
134
|
-
if (toId && !elementIds.has(toId)) {
|
|
135
|
-
findings.push({
|
|
136
|
-
scope: PScope,
|
|
137
|
-
id: relId,
|
|
138
|
-
message: `Referential integrity: relation '${relId || doc.path}' endpoint '${toId}' (to) does not resolve to a known element.`,
|
|
139
|
-
});
|
|
140
|
-
}
|
|
141
|
-
}
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
/** Phase 5 — ArchiMate layer-semantics on relations.
|
|
145
|
-
*
|
|
146
|
-
* lint.py ships `_check_semantic_rules` as a no-op stub (`pass`). It is ported
|
|
147
|
-
* here faithfully as a no-op so repo-scope validation reaches parity with
|
|
148
|
-
* lint.py on the reference fixture. Real layer-semantics rules are DEFERRED
|
|
149
|
-
* until the methodology defines them; when it does, they land here (a relation
|
|
150
|
-
* whose `type` is illegal between its endpoints' ArchiMate layers). Kept as a
|
|
151
|
-
* named hook so the intent — and the gap — is explicit rather than missing. */
|
|
152
|
-
function checkLayerSemantics(_input: RepoModelInput, _findings: RepoFinding[]): void {
|
|
153
|
-
// Intentionally empty — parity with lint.py's stubbed phase 5. Do not add
|
|
154
|
-
// rules here without coordinating the methodology semantics canon.
|
|
155
|
-
}
|
|
156
|
-
|
|
157
|
-
/** Phase 6 — an element that is Active/Production must declare an owner. */
|
|
158
|
-
function checkPolicy(input: RepoModelInput, findings: RepoFinding[]): void {
|
|
159
|
-
for (const doc of input.elements) {
|
|
160
|
-
const id = docId(doc);
|
|
161
|
-
if (!id || !doc.data) continue;
|
|
162
|
-
const metadata = doc.data['metadata'];
|
|
163
|
-
if (!isRecord(metadata)) continue;
|
|
164
|
-
const status = metadata['status'];
|
|
165
|
-
const owner = metadata['owner'];
|
|
166
|
-
if (typeof status === 'string' && OWNER_REQUIRED_STATUSES.has(status) && !owner) {
|
|
167
|
-
findings.push({
|
|
168
|
-
scope: PScope,
|
|
169
|
-
id,
|
|
170
|
-
message: `Policy: element '${id}' has status '${status}' but no owner assigned.`,
|
|
171
|
-
});
|
|
172
|
-
}
|
|
173
|
-
}
|
|
174
|
-
}
|
|
175
|
-
|
|
176
|
-
/**
|
|
177
|
-
* Run all repo-scope checks over a loaded canon model and return the findings.
|
|
178
|
-
* Pure: no IO, deterministic order (syntax, uniqueness, atomicity, referential,
|
|
179
|
-
* semantics, policy). Reaches parity with `lint.py` on the `acme_corp` fixture
|
|
180
|
-
* (zero findings on a clean tree).
|
|
181
|
-
*/
|
|
182
|
-
export function validateRepoModel(input: RepoModelInput): RepoFinding[] {
|
|
183
|
-
const findings: RepoFinding[] = [];
|
|
184
|
-
checkSyntax([...input.elements, ...input.relations], findings);
|
|
185
|
-
// A syntax error means the model is not reliably loaded; skip the graph checks
|
|
186
|
-
// and report the syntax problems first (mirrors lint.py, which bails after
|
|
187
|
-
// phase 1 on syntax errors).
|
|
188
|
-
if (findings.length > 0) return findings;
|
|
189
|
-
|
|
190
|
-
checkIdUniqueness(input, findings);
|
|
191
|
-
checkAtomicity(input, findings);
|
|
192
|
-
checkReferentialIntegrity(input, findings);
|
|
193
|
-
checkLayerSemantics(input, findings);
|
|
194
|
-
checkPolicy(input, findings);
|
|
195
|
-
return findings;
|
|
196
|
-
}
|
|
1
|
+
// Repo-scope validator (vkgeorgia/transitrix-studio#141).
|
|
2
|
+
//
|
|
3
|
+
// Pure port of the whole-repo checks owned by the methodology's
|
|
4
|
+
// `.validators/lint.py`, run over the shared TypeScript model instead of Python.
|
|
5
|
+
// Parity reference: the `acme_corp` worked example, which `lint.py` passes with
|
|
6
|
+
// zero findings — this validator must also produce zero findings on it.
|
|
7
|
+
//
|
|
8
|
+
// Ported checks (mirroring lint.py's phases):
|
|
9
|
+
// 1. YAML syntax (phase 1) — unparseable canon file -> finding.
|
|
10
|
+
// 2. ID uniqueness — same `id` defined in >1 file -> finding.
|
|
11
|
+
// (lint.py silently last-wins; we surface it,
|
|
12
|
+
// but acme_corp has no duplicates, so parity
|
|
13
|
+
// holds on the reference fixture.)
|
|
14
|
+
// 3. Atomicity (phase 3) — element file carrying a `relations:` key.
|
|
15
|
+
// 4. Referential integ. (phase 4) — relation endpoint not resolving to a known
|
|
16
|
+
// element id. We resolve the canonical
|
|
17
|
+
// `from`/`to` keys (the real relation schema)
|
|
18
|
+
// and also accept lint.py's `source`/`target`.
|
|
19
|
+
// 5. Semantic rules (phase 5) — ArchiMate layer-semantics. lint.py ships
|
|
20
|
+
// this as a no-op stub; ported faithfully as a
|
|
21
|
+
// no-op (see `checkLayerSemantics`). Deferred
|
|
22
|
+
// until the methodology defines the rules.
|
|
23
|
+
// 6. Policy (phase 6) — element marked Active/Production with no
|
|
24
|
+
// owner.
|
|
25
|
+
//
|
|
26
|
+
// Findings stay `{ scope, id, message }` — no severity, no target/category
|
|
27
|
+
// taxonomy (deferred per the ADR).
|
|
28
|
+
|
|
29
|
+
import type { RepoDoc, RepoFinding, RepoModelInput } from './types.js';
|
|
30
|
+
|
|
31
|
+
const PScope: RepoFinding['scope'] = 'repo';
|
|
32
|
+
|
|
33
|
+
/** Statuses that, per lint.py's policy check, require an owner. */
|
|
34
|
+
const OWNER_REQUIRED_STATUSES = new Set(['Active', 'Production']);
|
|
35
|
+
|
|
36
|
+
function isRecord(v: unknown): v is Record<string, unknown> {
|
|
37
|
+
return typeof v === 'object' && v !== null && !Array.isArray(v);
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/** Read a string `id` from a parsed doc, or `null` if absent/non-string.
|
|
41
|
+
* Mirrors lint.py, which only treats a doc as an element/relation when it has
|
|
42
|
+
* a top-level `id` (sidecars such as versioned-attribute files have no `id`
|
|
43
|
+
* and are ignored). */
|
|
44
|
+
function docId(doc: RepoDoc): string | null {
|
|
45
|
+
if (!doc.data) return null;
|
|
46
|
+
const id = doc.data['id'];
|
|
47
|
+
return typeof id === 'string' && id.length > 0 ? id : null;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/** Resolve a relation endpoint, which may be a bare id string or a `{ id }`
|
|
51
|
+
* mapping (lint.py accepts both). Returns the id string or `null`. */
|
|
52
|
+
function endpointId(value: unknown): string | null {
|
|
53
|
+
if (typeof value === 'string') return value.length > 0 ? value : null;
|
|
54
|
+
if (isRecord(value)) {
|
|
55
|
+
const id = value['id'];
|
|
56
|
+
if (typeof id === 'string' && id.length > 0) return id;
|
|
57
|
+
}
|
|
58
|
+
return null;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/** Phase 1 — unparseable canon files surface as findings. */
|
|
62
|
+
function checkSyntax(docs: RepoDoc[], findings: RepoFinding[]): void {
|
|
63
|
+
for (const doc of docs) {
|
|
64
|
+
if (doc.parseError) {
|
|
65
|
+
findings.push({
|
|
66
|
+
scope: PScope,
|
|
67
|
+
id: '',
|
|
68
|
+
message: `YAML syntax error in ${doc.path}: ${doc.parseError}`,
|
|
69
|
+
});
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
/** Phase 2 (as a check) — the same id defined in more than one file. */
|
|
75
|
+
function checkIdUniqueness(input: RepoModelInput, findings: RepoFinding[]): void {
|
|
76
|
+
const filesById = new Map<string, string[]>();
|
|
77
|
+
for (const doc of [...input.elements, ...input.relations]) {
|
|
78
|
+
const id = docId(doc);
|
|
79
|
+
if (!id) continue;
|
|
80
|
+
const list = filesById.get(id);
|
|
81
|
+
if (list) list.push(doc.path);
|
|
82
|
+
else filesById.set(id, [doc.path]);
|
|
83
|
+
}
|
|
84
|
+
for (const [id, files] of filesById) {
|
|
85
|
+
if (files.length > 1) {
|
|
86
|
+
findings.push({
|
|
87
|
+
scope: PScope,
|
|
88
|
+
id,
|
|
89
|
+
message: `Duplicate id '${id}' defined in ${files.length} files: ${files.join(', ')}`,
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
/** Phase 3 — relations must live in their own files, not inline on elements. */
|
|
96
|
+
function checkAtomicity(input: RepoModelInput, findings: RepoFinding[]): void {
|
|
97
|
+
for (const doc of input.elements) {
|
|
98
|
+
const id = docId(doc);
|
|
99
|
+
if (id && doc.data && 'relations' in doc.data) {
|
|
100
|
+
findings.push({
|
|
101
|
+
scope: PScope,
|
|
102
|
+
id,
|
|
103
|
+
message:
|
|
104
|
+
`Atomicity violation: element '${id}' (${doc.path}) contains a ` +
|
|
105
|
+
`'relations' section. Move relations to separate files under canon/relations/.`,
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
/** Phase 4 — every relation endpoint must resolve to a known element id. */
|
|
112
|
+
function checkReferentialIntegrity(input: RepoModelInput, findings: RepoFinding[]): void {
|
|
113
|
+
const elementIds = new Set<string>();
|
|
114
|
+
for (const doc of input.elements) {
|
|
115
|
+
const id = docId(doc);
|
|
116
|
+
if (id) elementIds.add(id);
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
for (const doc of input.relations) {
|
|
120
|
+
if (!doc.data) continue;
|
|
121
|
+
const relId = docId(doc) ?? '';
|
|
122
|
+
// Canonical relation schema uses `from`/`to`; `source`/`target` accepted for
|
|
123
|
+
// lint.py compatibility.
|
|
124
|
+
const fromId = endpointId(doc.data['from']) ?? endpointId(doc.data['source']);
|
|
125
|
+
const toId = endpointId(doc.data['to']) ?? endpointId(doc.data['target']);
|
|
126
|
+
|
|
127
|
+
if (fromId && !elementIds.has(fromId)) {
|
|
128
|
+
findings.push({
|
|
129
|
+
scope: PScope,
|
|
130
|
+
id: relId,
|
|
131
|
+
message: `Referential integrity: relation '${relId || doc.path}' endpoint '${fromId}' (from) does not resolve to a known element.`,
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
if (toId && !elementIds.has(toId)) {
|
|
135
|
+
findings.push({
|
|
136
|
+
scope: PScope,
|
|
137
|
+
id: relId,
|
|
138
|
+
message: `Referential integrity: relation '${relId || doc.path}' endpoint '${toId}' (to) does not resolve to a known element.`,
|
|
139
|
+
});
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
/** Phase 5 — ArchiMate layer-semantics on relations.
|
|
145
|
+
*
|
|
146
|
+
* lint.py ships `_check_semantic_rules` as a no-op stub (`pass`). It is ported
|
|
147
|
+
* here faithfully as a no-op so repo-scope validation reaches parity with
|
|
148
|
+
* lint.py on the reference fixture. Real layer-semantics rules are DEFERRED
|
|
149
|
+
* until the methodology defines them; when it does, they land here (a relation
|
|
150
|
+
* whose `type` is illegal between its endpoints' ArchiMate layers). Kept as a
|
|
151
|
+
* named hook so the intent — and the gap — is explicit rather than missing. */
|
|
152
|
+
function checkLayerSemantics(_input: RepoModelInput, _findings: RepoFinding[]): void {
|
|
153
|
+
// Intentionally empty — parity with lint.py's stubbed phase 5. Do not add
|
|
154
|
+
// rules here without coordinating the methodology semantics canon.
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
/** Phase 6 — an element that is Active/Production must declare an owner. */
|
|
158
|
+
function checkPolicy(input: RepoModelInput, findings: RepoFinding[]): void {
|
|
159
|
+
for (const doc of input.elements) {
|
|
160
|
+
const id = docId(doc);
|
|
161
|
+
if (!id || !doc.data) continue;
|
|
162
|
+
const metadata = doc.data['metadata'];
|
|
163
|
+
if (!isRecord(metadata)) continue;
|
|
164
|
+
const status = metadata['status'];
|
|
165
|
+
const owner = metadata['owner'];
|
|
166
|
+
if (typeof status === 'string' && OWNER_REQUIRED_STATUSES.has(status) && !owner) {
|
|
167
|
+
findings.push({
|
|
168
|
+
scope: PScope,
|
|
169
|
+
id,
|
|
170
|
+
message: `Policy: element '${id}' has status '${status}' but no owner assigned.`,
|
|
171
|
+
});
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
/**
|
|
177
|
+
* Run all repo-scope checks over a loaded canon model and return the findings.
|
|
178
|
+
* Pure: no IO, deterministic order (syntax, uniqueness, atomicity, referential,
|
|
179
|
+
* semantics, policy). Reaches parity with `lint.py` on the `acme_corp` fixture
|
|
180
|
+
* (zero findings on a clean tree).
|
|
181
|
+
*/
|
|
182
|
+
export function validateRepoModel(input: RepoModelInput): RepoFinding[] {
|
|
183
|
+
const findings: RepoFinding[] = [];
|
|
184
|
+
checkSyntax([...input.elements, ...input.relations], findings);
|
|
185
|
+
// A syntax error means the model is not reliably loaded; skip the graph checks
|
|
186
|
+
// and report the syntax problems first (mirrors lint.py, which bails after
|
|
187
|
+
// phase 1 on syntax errors).
|
|
188
|
+
if (findings.length > 0) return findings;
|
|
189
|
+
|
|
190
|
+
checkIdUniqueness(input, findings);
|
|
191
|
+
checkAtomicity(input, findings);
|
|
192
|
+
checkReferentialIntegrity(input, findings);
|
|
193
|
+
checkLayerSemantics(input, findings);
|
|
194
|
+
checkPolicy(input, findings);
|
|
195
|
+
return findings;
|
|
196
|
+
}
|
|
@@ -1,24 +1,24 @@
|
|
|
1
|
-
// Conformance test for the shipped REQUIREMENT worked examples — the
|
|
2
|
-
// acme_corp canon files mirrored under `tests/fixtures/notation-corpus/requirement/`. Pins the
|
|
3
|
-
// success signal of vkgeorgia/strategy#84 Phase 1: the library consumes the
|
|
4
|
-
// canonical example files without error.
|
|
5
|
-
|
|
6
|
-
import { describe, it, expect } from 'vitest';
|
|
7
|
-
import { readFileSync } from 'node:fs';
|
|
8
|
-
import { fileURLToPath } from 'node:url';
|
|
9
|
-
import path from 'node:path';
|
|
10
|
-
import yaml from 'js-yaml';
|
|
11
|
-
import { validateRequirement } from '../validate.js';
|
|
12
|
-
|
|
13
|
-
const dir = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../../../../tests/fixtures/notation-corpus/requirement');
|
|
14
|
-
const load = (f: string): unknown => yaml.load(readFileSync(path.join(dir, f), 'utf-8'));
|
|
15
|
-
|
|
16
|
-
describe('requirement worked examples (acme_corp)', () => {
|
|
17
|
-
for (const f of ['REQUIREMENT-DATA-ERASURE-1.yaml', 'REQUIREMENT-AUDIT-LOG-RETENTION-1.yaml']) {
|
|
18
|
-
it(`validates ${f} without error`, () => {
|
|
19
|
-
const v = validateRequirement(load(f));
|
|
20
|
-
expect(v.valid, JSON.stringify(v.errors)).toBe(true);
|
|
21
|
-
expect(v.errors).toHaveLength(0);
|
|
22
|
-
});
|
|
23
|
-
}
|
|
24
|
-
});
|
|
1
|
+
// Conformance test for the shipped REQUIREMENT worked examples — the
|
|
2
|
+
// acme_corp canon files mirrored under `tests/fixtures/notation-corpus/requirement/`. Pins the
|
|
3
|
+
// success signal of vkgeorgia/strategy#84 Phase 1: the library consumes the
|
|
4
|
+
// canonical example files without error.
|
|
5
|
+
|
|
6
|
+
import { describe, it, expect } from 'vitest';
|
|
7
|
+
import { readFileSync } from 'node:fs';
|
|
8
|
+
import { fileURLToPath } from 'node:url';
|
|
9
|
+
import path from 'node:path';
|
|
10
|
+
import yaml from 'js-yaml';
|
|
11
|
+
import { validateRequirement } from '../validate.js';
|
|
12
|
+
|
|
13
|
+
const dir = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../../../../tests/fixtures/notation-corpus/requirement');
|
|
14
|
+
const load = (f: string): unknown => yaml.load(readFileSync(path.join(dir, f), 'utf-8'));
|
|
15
|
+
|
|
16
|
+
describe('requirement worked examples (acme_corp)', () => {
|
|
17
|
+
for (const f of ['REQUIREMENT-DATA-ERASURE-1.yaml', 'REQUIREMENT-AUDIT-LOG-RETENTION-1.yaml']) {
|
|
18
|
+
it(`validates ${f} without error`, () => {
|
|
19
|
+
const v = validateRequirement(load(f));
|
|
20
|
+
expect(v.valid, JSON.stringify(v.errors)).toBe(true);
|
|
21
|
+
expect(v.errors).toHaveLength(0);
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
});
|
|
@@ -1,96 +1,96 @@
|
|
|
1
|
-
import { describe, it, expect } from 'vitest';
|
|
2
|
-
import { validateRequirement } from '../validate.js';
|
|
3
|
-
import type { CanonCatalog } from '../../typed-id.js';
|
|
4
|
-
|
|
5
|
-
function valid(): Record<string, unknown> {
|
|
6
|
-
return {
|
|
7
|
-
notation: 'requirement',
|
|
8
|
-
id: 'REQUIREMENT-DATA-ERASURE-1',
|
|
9
|
-
name: 'Personal-data erasure within 30 days',
|
|
10
|
-
description: 'The controller must erase personal data within 30 days of a verified request.',
|
|
11
|
-
severity: 'high',
|
|
12
|
-
zone: 'canon',
|
|
13
|
-
admitted_at: '2026-05-28',
|
|
14
|
-
admitted_by: 'v.korobeinikov',
|
|
15
|
-
gate_checks: { uniqueness: 'pass', consistency: 'pass', completeness: 'pass' },
|
|
16
|
-
valid_from: '2017-05-01',
|
|
17
|
-
valid_to: null,
|
|
18
|
-
};
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
const codes = (input: unknown, opts?: Parameters<typeof validateRequirement>[1]): string[] =>
|
|
22
|
-
validateRequirement(input, opts).errors.map(e => e.code);
|
|
23
|
-
|
|
24
|
-
describe('validateRequirement — positive', () => {
|
|
25
|
-
it('accepts a well-formed requirement', () => {
|
|
26
|
-
const r = validateRequirement(valid());
|
|
27
|
-
expect(r.valid, JSON.stringify(r.errors)).toBe(true);
|
|
28
|
-
expect(r.errors).toHaveLength(0);
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
it('accepts an internal-only requirement with no derived_from', () => {
|
|
32
|
-
const r = valid();
|
|
33
|
-
delete r.derived_from;
|
|
34
|
-
r.severity = 'medium';
|
|
35
|
-
expect(validateRequirement(r).valid).toBe(true);
|
|
36
|
-
});
|
|
37
|
-
});
|
|
38
|
-
|
|
39
|
-
describe('validateRequirement — REQ-001 (shape / id grammar)', () => {
|
|
40
|
-
it('flags a missing required field', () => {
|
|
41
|
-
const r = valid();
|
|
42
|
-
delete r.name;
|
|
43
|
-
expect(codes(r)).toContain('REQ-001');
|
|
44
|
-
});
|
|
45
|
-
|
|
46
|
-
it('flags an id that violates the grammar', () => {
|
|
47
|
-
expect(codes({ ...valid(), id: 'REQUIREMENT-DATA-ERASURE-001' })).toContain('REQ-001'); // leading zero
|
|
48
|
-
expect(codes({ ...valid(), id: 'REQ-1' })).toContain('REQ-001'); // wrong TYPE
|
|
49
|
-
expect(codes({ ...valid(), id: 'requirement-data-1' })).toContain('REQ-001'); // lowercase TYPE
|
|
50
|
-
});
|
|
51
|
-
|
|
52
|
-
it('flags a wrong notation tag and a non-canon zone', () => {
|
|
53
|
-
expect(codes({ ...valid(), notation: 'req' })).toContain('REQ-001');
|
|
54
|
-
expect(codes({ ...valid(), zone: 'sandbox' })).toContain('REQ-001');
|
|
55
|
-
});
|
|
56
|
-
|
|
57
|
-
it('flags a missing valid_to key (distinct from a null value)', () => {
|
|
58
|
-
const r = valid();
|
|
59
|
-
delete r.valid_to;
|
|
60
|
-
expect(codes(r)).toContain('REQ-001');
|
|
61
|
-
expect(validateRequirement({ ...valid(), valid_to: null }).valid).toBe(true);
|
|
62
|
-
});
|
|
63
|
-
|
|
64
|
-
it('rejects a non-object', () => {
|
|
65
|
-
expect(codes(null)).toEqual(['REQ-001']);
|
|
66
|
-
expect(codes('x')).toEqual(['REQ-001']);
|
|
67
|
-
expect(codes(['a'])).toEqual(['REQ-001']);
|
|
68
|
-
});
|
|
69
|
-
});
|
|
70
|
-
|
|
71
|
-
describe('validateRequirement — REQ-002 (derived_from resolution)', () => {
|
|
72
|
-
it('flags a well-formed allowed-type ref that does not resolve in the catalog', () => {
|
|
73
|
-
const catalog: CanonCatalog = { typeOf: () => undefined };
|
|
74
|
-
expect(codes({ ...valid(), derived_from: ['LAW-PERSONAL-DATA-2017-1'] }, { catalog })).toContain('REQ-002');
|
|
75
|
-
});
|
|
76
|
-
|
|
77
|
-
it('flags a malformed derived_from entry (cannot resolve)', () => {
|
|
78
|
-
expect(codes({ ...valid(), derived_from: ['not an id'] })).toContain('REQ-002');
|
|
79
|
-
});
|
|
80
|
-
|
|
81
|
-
it('does not flag REQ-002 without a catalog for a well-formed allowed-type ref', () => {
|
|
82
|
-
expect(codes({ ...valid(), derived_from: ['LAW-PERSONAL-DATA-2017-1'] })).not.toContain('REQ-002');
|
|
83
|
-
});
|
|
84
|
-
});
|
|
85
|
-
|
|
86
|
-
describe('validateRequirement — REQ-003 (derived_from TYPE)', () => {
|
|
87
|
-
it('flags a derived_from TYPE outside LAW/REGULATION/POLICY/INTERNAL_STANDARD', () => {
|
|
88
|
-
expect(codes({ ...valid(), derived_from: ['PRODUCT-MOBILE-1'] })).toContain('REQ-003');
|
|
89
|
-
});
|
|
90
|
-
|
|
91
|
-
it('accepts each permitted derived_from TYPE', () => {
|
|
92
|
-
for (const id of ['LAW-X-1', 'REGULATION-X-1', 'POLICY-X-1', 'INTERNAL_STANDARD-X-1']) {
|
|
93
|
-
expect(codes({ ...valid(), derived_from: [id] })).not.toContain('REQ-003');
|
|
94
|
-
}
|
|
95
|
-
});
|
|
96
|
-
});
|
|
1
|
+
import { describe, it, expect } from 'vitest';
|
|
2
|
+
import { validateRequirement } from '../validate.js';
|
|
3
|
+
import type { CanonCatalog } from '../../typed-id.js';
|
|
4
|
+
|
|
5
|
+
function valid(): Record<string, unknown> {
|
|
6
|
+
return {
|
|
7
|
+
notation: 'requirement',
|
|
8
|
+
id: 'REQUIREMENT-DATA-ERASURE-1',
|
|
9
|
+
name: 'Personal-data erasure within 30 days',
|
|
10
|
+
description: 'The controller must erase personal data within 30 days of a verified request.',
|
|
11
|
+
severity: 'high',
|
|
12
|
+
zone: 'canon',
|
|
13
|
+
admitted_at: '2026-05-28',
|
|
14
|
+
admitted_by: 'v.korobeinikov',
|
|
15
|
+
gate_checks: { uniqueness: 'pass', consistency: 'pass', completeness: 'pass' },
|
|
16
|
+
valid_from: '2017-05-01',
|
|
17
|
+
valid_to: null,
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
const codes = (input: unknown, opts?: Parameters<typeof validateRequirement>[1]): string[] =>
|
|
22
|
+
validateRequirement(input, opts).errors.map(e => e.code);
|
|
23
|
+
|
|
24
|
+
describe('validateRequirement — positive', () => {
|
|
25
|
+
it('accepts a well-formed requirement', () => {
|
|
26
|
+
const r = validateRequirement(valid());
|
|
27
|
+
expect(r.valid, JSON.stringify(r.errors)).toBe(true);
|
|
28
|
+
expect(r.errors).toHaveLength(0);
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
it('accepts an internal-only requirement with no derived_from', () => {
|
|
32
|
+
const r = valid();
|
|
33
|
+
delete r.derived_from;
|
|
34
|
+
r.severity = 'medium';
|
|
35
|
+
expect(validateRequirement(r).valid).toBe(true);
|
|
36
|
+
});
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
describe('validateRequirement — REQ-001 (shape / id grammar)', () => {
|
|
40
|
+
it('flags a missing required field', () => {
|
|
41
|
+
const r = valid();
|
|
42
|
+
delete r.name;
|
|
43
|
+
expect(codes(r)).toContain('REQ-001');
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
it('flags an id that violates the grammar', () => {
|
|
47
|
+
expect(codes({ ...valid(), id: 'REQUIREMENT-DATA-ERASURE-001' })).toContain('REQ-001'); // leading zero
|
|
48
|
+
expect(codes({ ...valid(), id: 'REQ-1' })).toContain('REQ-001'); // wrong TYPE
|
|
49
|
+
expect(codes({ ...valid(), id: 'requirement-data-1' })).toContain('REQ-001'); // lowercase TYPE
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
it('flags a wrong notation tag and a non-canon zone', () => {
|
|
53
|
+
expect(codes({ ...valid(), notation: 'req' })).toContain('REQ-001');
|
|
54
|
+
expect(codes({ ...valid(), zone: 'sandbox' })).toContain('REQ-001');
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
it('flags a missing valid_to key (distinct from a null value)', () => {
|
|
58
|
+
const r = valid();
|
|
59
|
+
delete r.valid_to;
|
|
60
|
+
expect(codes(r)).toContain('REQ-001');
|
|
61
|
+
expect(validateRequirement({ ...valid(), valid_to: null }).valid).toBe(true);
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
it('rejects a non-object', () => {
|
|
65
|
+
expect(codes(null)).toEqual(['REQ-001']);
|
|
66
|
+
expect(codes('x')).toEqual(['REQ-001']);
|
|
67
|
+
expect(codes(['a'])).toEqual(['REQ-001']);
|
|
68
|
+
});
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
describe('validateRequirement — REQ-002 (derived_from resolution)', () => {
|
|
72
|
+
it('flags a well-formed allowed-type ref that does not resolve in the catalog', () => {
|
|
73
|
+
const catalog: CanonCatalog = { typeOf: () => undefined };
|
|
74
|
+
expect(codes({ ...valid(), derived_from: ['LAW-PERSONAL-DATA-2017-1'] }, { catalog })).toContain('REQ-002');
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
it('flags a malformed derived_from entry (cannot resolve)', () => {
|
|
78
|
+
expect(codes({ ...valid(), derived_from: ['not an id'] })).toContain('REQ-002');
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
it('does not flag REQ-002 without a catalog for a well-formed allowed-type ref', () => {
|
|
82
|
+
expect(codes({ ...valid(), derived_from: ['LAW-PERSONAL-DATA-2017-1'] })).not.toContain('REQ-002');
|
|
83
|
+
});
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
describe('validateRequirement — REQ-003 (derived_from TYPE)', () => {
|
|
87
|
+
it('flags a derived_from TYPE outside LAW/REGULATION/POLICY/INTERNAL_STANDARD', () => {
|
|
88
|
+
expect(codes({ ...valid(), derived_from: ['PRODUCT-MOBILE-1'] })).toContain('REQ-003');
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
it('accepts each permitted derived_from TYPE', () => {
|
|
92
|
+
for (const id of ['LAW-X-1', 'REGULATION-X-1', 'POLICY-X-1', 'INTERNAL_STANDARD-X-1']) {
|
|
93
|
+
expect(codes({ ...valid(), derived_from: [id] })).not.toContain('REQ-003');
|
|
94
|
+
}
|
|
95
|
+
});
|
|
96
|
+
});
|
package/src/requirement/index.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type { Requirement, RequirementSeverity, GateChecks } from './types.js';
|
|
2
|
-
export { REQUIREMENT_DERIVED_FROM_TYPES } from './types.js';
|
|
3
|
-
export { validateRequirement } from './validate.js';
|
|
4
|
-
export type { RequirementValidateOptions } from './validate.js';
|
|
1
|
+
export type { Requirement, RequirementSeverity, GateChecks } from './types.js';
|
|
2
|
+
export { REQUIREMENT_DERIVED_FROM_TYPES } from './types.js';
|
|
3
|
+
export { validateRequirement } from './validate.js';
|
|
4
|
+
export type { RequirementValidateOptions } from './validate.js';
|