@transitrix/diagrams 1.0.0 → 1.0.1
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/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 +139 -6
- 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 +107 -26
- 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 +311 -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 +77 -74
- package/dist/compliance/impact.d.ts +77 -16
- package/dist/compliance/impact.js +193 -25
- 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 +74 -45
- package/dist/factor/index.d.ts +3 -2
- package/dist/factor/index.js +1 -1
- package/dist/factor/types.d.ts +4 -7
- 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__/resolver.test.js +185 -0
- package/dist/fgca/index.d.ts +2 -0
- package/dist/fgca/index.js +1 -0
- package/dist/fgca/resolver.d.ts +49 -0
- package/dist/fgca/resolver.js +124 -0
- 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/layout.js +5 -1
- package/dist/process-blueprint/types.d.ts +22 -1
- 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 +69 -69
- package/dist/webview/__tests__/entry.test.js +11 -11
- package/dist/webview/render-activities.d.ts +3 -1
- package/dist/webview/render-activities.js +2 -2
- package/dist/webview/render-activity-card.js +104 -77
- package/dist/webview/render-fgca.d.ts +4 -0
- package/dist/webview/render-fgca.js +2 -5
- package/dist/webview/render-goals.d.ts +1 -0
- package/dist/webview/render-goals.js +15 -15
- package/dist/webview/render-process-blueprint.js +10 -10
- package/package.json +40 -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 +95 -95
- package/src/activities/gantt.ts +276 -276
- package/src/activities/index.ts +28 -28
- package/src/activities/layout.ts +112 -112
- package/src/activities/types.ts +148 -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 +307 -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 +415 -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 +840 -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 +298 -295
- package/src/compliance/impact.ts +861 -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 +80 -45
- package/src/factor/index.ts +3 -7
- package/src/factor/types.ts +14 -18
- 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 +400 -400
- package/src/fgca/preview-layout.ts +217 -217
- package/src/fgca/resolver.ts +157 -0
- package/src/fgca/types.ts +50 -50
- package/src/fgca/validate.ts +126 -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 +31 -31
- package/src/process-blueprint/layout.ts +535 -531
- package/src/process-blueprint/types.ts +263 -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 +237 -237
- package/src/theme/tokens.ts +133 -133
- package/src/typed-id.ts +56 -56
- package/src/validation-types.ts +36 -36
- package/src/webview/__tests__/entry-notations.test.ts +77 -77
- package/src/webview/__tests__/entry.test.ts +64 -64
- package/src/webview/__tests__/render-goals.test.ts +72 -72
- package/src/webview/entry.ts +292 -292
- package/src/webview/render-activities.ts +5 -3
- package/src/webview/render-activity-card.ts +266 -234
- package/src/webview/render-fgca.ts +6 -5
- package/src/webview/render-goals.ts +111 -110
- package/src/webview/render-process-blueprint.ts +207 -207
- 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.d.ts +0 -1
- 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
|
@@ -156,4 +156,41 @@ describe('layoutProcessBlueprint', () => {
|
|
|
156
156
|
expect(layout.stageColumnWidth).toBe(300);
|
|
157
157
|
expect(layout.stageHeaders[1].x).toBe(200 + 300);
|
|
158
158
|
});
|
|
159
|
+
describe('visibleAspects', () => {
|
|
160
|
+
const FILE_WITH_ALL = build({
|
|
161
|
+
stages: [{ id: 'STAGE-1', name: 'A', goal: 'g', result: 'r' }],
|
|
162
|
+
systems: [{ name: 'OMS', stages: ['STAGE-1'] }],
|
|
163
|
+
actors: [{ name: 'Ops', stages: ['STAGE-1'] }],
|
|
164
|
+
equipment: [{ name: 'Printer', stages: ['STAGE-1'] }],
|
|
165
|
+
});
|
|
166
|
+
it('shows all categories when visibleAspects is not set', () => {
|
|
167
|
+
const layout = layoutProcessBlueprint(FILE_WITH_ALL);
|
|
168
|
+
expect(layout.aspectRows.map(r => r.category)).toEqual(expect.arrayContaining(['systems', 'actors', 'equipment']));
|
|
169
|
+
expect(layout.aspectRows).toHaveLength(3);
|
|
170
|
+
});
|
|
171
|
+
it('limits rows to those in visibleAspects', () => {
|
|
172
|
+
const layout = layoutProcessBlueprint(FILE_WITH_ALL, {
|
|
173
|
+
visibleAspects: ['systems'],
|
|
174
|
+
});
|
|
175
|
+
expect(layout.aspectRows).toHaveLength(1);
|
|
176
|
+
expect(layout.aspectRows[0].category).toBe('systems');
|
|
177
|
+
});
|
|
178
|
+
it('suppresses all aspect rows when visibleAspects is empty', () => {
|
|
179
|
+
const layout = layoutProcessBlueprint(FILE_WITH_ALL, { visibleAspects: [] });
|
|
180
|
+
expect(layout.aspectRows).toHaveLength(0);
|
|
181
|
+
});
|
|
182
|
+
it('preserves the canonical ASPECT_CATEGORIES order within the filtered set', () => {
|
|
183
|
+
const layout = layoutProcessBlueprint(FILE_WITH_ALL, {
|
|
184
|
+
visibleAspects: ['equipment', 'systems'],
|
|
185
|
+
});
|
|
186
|
+
expect(layout.aspectRows.map(r => r.category)).toEqual(['systems', 'equipment']);
|
|
187
|
+
});
|
|
188
|
+
it('ignores categories in visibleAspects that have no data', () => {
|
|
189
|
+
const layout = layoutProcessBlueprint(FILE_WITH_ALL, {
|
|
190
|
+
visibleAspects: ['systems', 'information_entities'],
|
|
191
|
+
});
|
|
192
|
+
expect(layout.aspectRows).toHaveLength(1);
|
|
193
|
+
expect(layout.aspectRows[0].category).toBe('systems');
|
|
194
|
+
});
|
|
195
|
+
});
|
|
159
196
|
});
|
|
@@ -331,9 +331,13 @@ export function layoutProcessBlueprint(file, options) {
|
|
|
331
331
|
}));
|
|
332
332
|
const aspectsStartY = resultRowY + resultRowHeight;
|
|
333
333
|
// Aspect rows: only categories with at least one entry, in fixed order.
|
|
334
|
+
// When visibleAspects is set, skip categories not in the list.
|
|
335
|
+
const aspectCategoriesToRender = opts.visibleAspects !== undefined
|
|
336
|
+
? ASPECT_CATEGORIES.filter(c => opts.visibleAspects.includes(c))
|
|
337
|
+
: ASPECT_CATEGORIES;
|
|
334
338
|
const aspectRows = [];
|
|
335
339
|
let aspectCursorY = aspectsStartY;
|
|
336
|
-
for (const category of
|
|
340
|
+
for (const category of aspectCategoriesToRender) {
|
|
337
341
|
const arr = pb?.[category];
|
|
338
342
|
if (!Array.isArray(arr) || arr.length === 0)
|
|
339
343
|
continue;
|
|
@@ -24,7 +24,7 @@ export interface ComplianceLaneAssertion {
|
|
|
24
24
|
/** Requirement ID this assertion is about. */
|
|
25
25
|
about: string;
|
|
26
26
|
/** Compliance realisation status. */
|
|
27
|
-
status: 'compliant' | 'partial' | 'non_compliant' | 'under_review' | 'n_a';
|
|
27
|
+
status: 'compliant' | 'partial' | 'non_compliant' | 'under_review' | 'pending_owner' | 'n_a';
|
|
28
28
|
/**
|
|
29
29
|
* Typed IDs of stages / process steps where the requirement is realised.
|
|
30
30
|
* When empty/absent, the assertion covers the entire subject, not a specific stage.
|
|
@@ -106,7 +106,22 @@ export interface LaneConfig {
|
|
|
106
106
|
compliance_filter?: {
|
|
107
107
|
/** ISO jurisdiction codes; empty array means all jurisdictions. */
|
|
108
108
|
jurisdictions?: string[];
|
|
109
|
+
/**
|
|
110
|
+
* Per-stage map of law IDs known from the previous generated snapshot.
|
|
111
|
+
* Key: stage ID; Value: array of law IDs present in that stage's previous report.
|
|
112
|
+
* Laws absent from the previous snapshot receive the `new` decoration.
|
|
113
|
+
* When absent, every law chip is treated as new.
|
|
114
|
+
*/
|
|
115
|
+
previous_snapshot?: Record<string, string[]>;
|
|
109
116
|
};
|
|
117
|
+
/**
|
|
118
|
+
* Lanes to show; controls which aspect rows and the compliance lane are rendered.
|
|
119
|
+
* Valid values: `"systems"` | `"actors"` | `"equipment"` | `"information_entities"` | `"compliance"`.
|
|
120
|
+
* When absent, all lanes with data are shown (current default behaviour).
|
|
121
|
+
* Named report config — committed, versioned. Per-user overrides live in
|
|
122
|
+
* `.transitrix/display-preferences/process-blueprint.json` (gitignored, never committed).
|
|
123
|
+
*/
|
|
124
|
+
visible_lanes?: string[];
|
|
110
125
|
}
|
|
111
126
|
export interface ProcessBlueprintHeader {
|
|
112
127
|
id: string;
|
|
@@ -155,6 +170,12 @@ export interface ProcessBlueprintLayoutOptions {
|
|
|
155
170
|
complianceLane?: ComplianceLaneConfig;
|
|
156
171
|
/** Assertion + requirement data for the compliance lane derivation. */
|
|
157
172
|
complianceInput?: ComplianceLaneInput;
|
|
173
|
+
/**
|
|
174
|
+
* Restrict which aspect-category rows are rendered.
|
|
175
|
+
* When absent, all categories that have at least one entry are shown.
|
|
176
|
+
* Pass an empty array to suppress all aspect rows.
|
|
177
|
+
*/
|
|
178
|
+
visibleAspects?: AspectCategory[];
|
|
158
179
|
}
|
|
159
180
|
import type { LayoutBounds } from '../geometry.js';
|
|
160
181
|
export type { LayoutBounds };
|
|
@@ -7,7 +7,7 @@ function valid() {
|
|
|
7
7
|
name: 'Data Protection Authority',
|
|
8
8
|
type: 'external',
|
|
9
9
|
actor: 'ACTOR-DPA-1',
|
|
10
|
-
concern: 'Lawful processing and timely erasure of
|
|
10
|
+
concern: 'Lawful processing and timely erasure of personal data.',
|
|
11
11
|
interest: 'high',
|
|
12
12
|
influence: 'high',
|
|
13
13
|
description: 'External oversight stakeholder.',
|
|
@@ -19,68 +19,70 @@ function valid() {
|
|
|
19
19
|
valid_to: null,
|
|
20
20
|
};
|
|
21
21
|
}
|
|
22
|
-
const codes = (input) => validateStakeholder(input).errors.map(e => e.code);
|
|
22
|
+
const codes = (input, opts) => validateStakeholder(input, opts).errors.map(e => e.code);
|
|
23
23
|
describe('validateStakeholder — positive', () => {
|
|
24
|
-
it('accepts
|
|
24
|
+
it('accepts a well-formed external stakeholder', () => {
|
|
25
25
|
const r = validateStakeholder(valid());
|
|
26
26
|
expect(r.valid, JSON.stringify(r.errors)).toBe(true);
|
|
27
|
-
expect(r.errors).toHaveLength(0);
|
|
28
27
|
});
|
|
29
|
-
it('accepts a minimal stakeholder
|
|
30
|
-
const
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
28
|
+
it('accepts a minimal internal stakeholder with no optional profile fields', () => {
|
|
29
|
+
const s = valid();
|
|
30
|
+
s.id = 'STAKEHOLDER-OPS-1';
|
|
31
|
+
s.name = 'Operations';
|
|
32
|
+
s.type = 'internal';
|
|
33
|
+
s.actor = 'ACTOR-OPS-1';
|
|
34
|
+
delete s.concern;
|
|
35
|
+
delete s.interest;
|
|
36
|
+
delete s.influence;
|
|
37
|
+
delete s.description;
|
|
38
|
+
expect(validateStakeholder(s).valid).toBe(true);
|
|
35
39
|
});
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
expect(codes(null)).toEqual(['STAKEHOLDER-001']);
|
|
40
|
+
it('accepts when the catalog resolves the actor', () => {
|
|
41
|
+
const catalog = { typeOf: id => (id === 'ACTOR-DPA-1' ? 'ACTOR' : undefined) };
|
|
42
|
+
expect(validateStakeholder(valid(), { catalog }).valid).toBe(true);
|
|
40
43
|
});
|
|
41
|
-
|
|
42
|
-
|
|
44
|
+
});
|
|
45
|
+
describe('validateStakeholder — STAKE-001 (shape / id grammar / levels)', () => {
|
|
46
|
+
it('flags a missing required envelope field', () => {
|
|
47
|
+
const s = valid();
|
|
48
|
+
delete s.name;
|
|
49
|
+
expect(codes(s)).toContain('STAKE-001');
|
|
43
50
|
});
|
|
44
|
-
it('flags an id
|
|
45
|
-
expect(codes({ ...valid(), id: '
|
|
51
|
+
it('flags an id that violates the grammar', () => {
|
|
52
|
+
expect(codes({ ...valid(), id: 'STAKEHOLDER-DPA-001' })).toContain('STAKE-001');
|
|
53
|
+
expect(codes({ ...valid(), id: 'STAKE-1' })).toContain('STAKE-001');
|
|
46
54
|
});
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
it('flags a missing type', () => {
|
|
50
|
-
const r = valid();
|
|
51
|
-
delete r.type;
|
|
52
|
-
expect(codes(r)).toContain('STAKEHOLDER-002');
|
|
55
|
+
it('flags a wrong notation tag', () => {
|
|
56
|
+
expect(codes({ ...valid(), notation: 'stakeholders' })).toContain('STAKE-001');
|
|
53
57
|
});
|
|
54
|
-
it('flags
|
|
55
|
-
expect(codes({ ...valid(),
|
|
58
|
+
it('flags an interest / influence value outside {high, medium, low}', () => {
|
|
59
|
+
expect(codes({ ...valid(), interest: 'critical' })).toContain('STAKE-001');
|
|
60
|
+
expect(codes({ ...valid(), influence: 'none' })).toContain('STAKE-001');
|
|
56
61
|
});
|
|
57
|
-
it('
|
|
58
|
-
|
|
59
|
-
expect(validateStakeholder({ ...valid(), type: t }).valid).toBe(true);
|
|
60
|
-
}
|
|
62
|
+
it('rejects a non-object', () => {
|
|
63
|
+
expect(codes(null)).toEqual(['STAKE-001']);
|
|
61
64
|
});
|
|
62
65
|
});
|
|
63
|
-
describe('validateStakeholder —
|
|
66
|
+
describe('validateStakeholder — STAKE-002 (actor binding)', () => {
|
|
64
67
|
it('flags a missing actor', () => {
|
|
65
|
-
const
|
|
66
|
-
delete
|
|
67
|
-
expect(codes(
|
|
68
|
+
const s = valid();
|
|
69
|
+
delete s.actor;
|
|
70
|
+
expect(codes(s)).toContain('STAKE-002');
|
|
68
71
|
});
|
|
69
|
-
it('flags an actor
|
|
70
|
-
expect(codes({ ...valid(), actor: 'ROLE-
|
|
71
|
-
expect(codes({ ...valid(), actor: 'not an id' })).toContain('STAKEHOLDER-003');
|
|
72
|
+
it('flags an actor of the wrong TYPE', () => {
|
|
73
|
+
expect(codes({ ...valid(), actor: 'ROLE-OPS-1' })).toContain('STAKE-002');
|
|
72
74
|
});
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
expect(codes({ ...valid(), interest: 'extreme' })).toContain('STAKEHOLDER-004');
|
|
75
|
+
it('flags an actor that does not resolve when a catalog is supplied', () => {
|
|
76
|
+
const catalog = { typeOf: () => undefined };
|
|
77
|
+
expect(codes(valid(), { catalog })).toContain('STAKE-002');
|
|
77
78
|
});
|
|
78
|
-
it('flags an
|
|
79
|
-
|
|
79
|
+
it('flags an actor whose catalog TYPE is not ACTOR', () => {
|
|
80
|
+
const catalog = { typeOf: () => 'ROLE' };
|
|
81
|
+
expect(codes(valid(), { catalog })).toContain('STAKE-002');
|
|
80
82
|
});
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
}
|
|
83
|
+
});
|
|
84
|
+
describe('validateStakeholder — STAKE-003 (type enum)', () => {
|
|
85
|
+
it('flags a type outside {internal, external}', () => {
|
|
86
|
+
expect(codes({ ...valid(), type: 'partner' })).toContain('STAKE-003');
|
|
85
87
|
});
|
|
86
88
|
});
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
import type { GateChecks } from '../requirement/types.js';
|
|
2
|
-
export type StakeholderType = 'internal' | 'external';
|
|
3
2
|
export declare const STAKEHOLDER_TYPES: readonly ["internal", "external"];
|
|
4
|
-
export type
|
|
3
|
+
export type StakeholderType = typeof STAKEHOLDER_TYPES[number];
|
|
5
4
|
export declare const STAKEHOLDER_LEVELS: readonly ["high", "medium", "low"];
|
|
5
|
+
export type StakeholderLevel = typeof STAKEHOLDER_LEVELS[number];
|
|
6
6
|
export interface Stakeholder {
|
|
7
7
|
notation: 'stakeholder';
|
|
8
8
|
id: string;
|
|
9
9
|
name: string;
|
|
10
|
-
/** Required subtype — internal | external. */
|
|
11
10
|
type: StakeholderType;
|
|
12
|
-
/**
|
|
11
|
+
/** ACTOR-… whose identity this stake attaches to (STAKE-002). */
|
|
13
12
|
actor: string;
|
|
14
13
|
concern?: string;
|
|
15
14
|
interest?: StakeholderLevel;
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
// STAKEHOLDER — motivation-layer interest primitive.
|
|
2
|
-
// Schema: methodology notations/ELEMENT_PRIMITIVES.md §7.
|
|
3
|
-
// notations/elements/20-stakeholders.md + envelope §3.
|
|
1
|
+
// STAKEHOLDER — motivation-layer interest primitive (ArchiMate Stakeholder).
|
|
2
|
+
// Schema: methodology notations/elements/20-stakeholders.md + ELEMENT_PRIMITIVES.md §7.16.
|
|
4
3
|
export const STAKEHOLDER_TYPES = ['internal', 'external'];
|
|
5
4
|
export const STAKEHOLDER_LEVELS = ['high', 'medium', 'low'];
|
|
@@ -1,2 +1,7 @@
|
|
|
1
1
|
import type { ValidationResult } from '../validation-types.js';
|
|
2
|
-
|
|
2
|
+
import { type CanonCatalog } from '../typed-id.js';
|
|
3
|
+
export interface StakeholderValidateOptions {
|
|
4
|
+
/** When provided, STAKE-002 enforces that `actor` resolves to an admitted ACTOR. */
|
|
5
|
+
catalog?: CanonCatalog;
|
|
6
|
+
}
|
|
7
|
+
export declare function validateStakeholder(input: unknown, options?: StakeholderValidateOptions): ValidationResult;
|
|
@@ -1,57 +1,78 @@
|
|
|
1
|
-
// STAKEHOLDER validator — methodology notations/
|
|
2
|
-
// + notations/elements/20-stakeholders.md.
|
|
1
|
+
// STAKEHOLDER validator — methodology notations/elements/20-stakeholders.md §5.
|
|
3
2
|
//
|
|
4
|
-
//
|
|
5
|
-
//
|
|
6
|
-
//
|
|
7
|
-
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
|
|
3
|
+
// Codes:
|
|
4
|
+
// STAKE-001 — shape / id grammar / required envelope / interest|influence enum.
|
|
5
|
+
// STAKE-002 — `actor` missing, malformed, wrong TYPE, or unresolved in catalog.
|
|
6
|
+
// STAKE-003 — `type` outside {internal, external}.
|
|
7
|
+
import { typeOfId, isCanonicalIdOfType } from '../typed-id.js';
|
|
8
|
+
import { STAKEHOLDER_TYPES, STAKEHOLDER_LEVELS } from './types.js';
|
|
9
|
+
const REQUIRED_STRING_FIELDS = [
|
|
10
|
+
'name', 'admitted_at', 'admitted_by', 'valid_from',
|
|
11
|
+
];
|
|
12
|
+
const TYPES = STAKEHOLDER_TYPES;
|
|
13
|
+
const LEVELS = STAKEHOLDER_LEVELS;
|
|
14
|
+
export function validateStakeholder(input, options = {}) {
|
|
11
15
|
const errors = [];
|
|
12
16
|
const warnings = [];
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
idType: 'STAKEHOLDER',
|
|
16
|
-
code: 'STAKEHOLDER-001',
|
|
17
|
-
});
|
|
18
|
-
errors.push(...envErrors);
|
|
19
|
-
if (!record)
|
|
17
|
+
if (input === null || typeof input !== 'object' || Array.isArray(input)) {
|
|
18
|
+
errors.push({ code: 'STAKE-001', message: 'Stakeholder must be a YAML mapping.' });
|
|
20
19
|
return { valid: false, errors, warnings };
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
if (
|
|
34
|
-
errors.push({
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
20
|
+
}
|
|
21
|
+
const s = input;
|
|
22
|
+
// STAKE-001 — id grammar + notation tag + envelope.
|
|
23
|
+
if (!isCanonicalIdOfType(s.id, 'STAKEHOLDER')) {
|
|
24
|
+
errors.push({ code: 'STAKE-001', message: `id "${String(s.id)}" must match STAKEHOLDER-[<middle>-]<INTEGER>.`, path: 'id' });
|
|
25
|
+
}
|
|
26
|
+
if (s.notation !== 'stakeholder') {
|
|
27
|
+
errors.push({ code: 'STAKE-001', message: 'notation must be the fixed value "stakeholder".', path: 'notation' });
|
|
28
|
+
}
|
|
29
|
+
if (s.zone !== undefined && s.zone !== 'canon') {
|
|
30
|
+
errors.push({ code: 'STAKE-001', message: 'zone must be "canon" for a STAKEHOLDER.', path: 'zone' });
|
|
31
|
+
}
|
|
32
|
+
else if (s.zone === undefined) {
|
|
33
|
+
errors.push({ code: 'STAKE-001', message: 'zone is required.', path: 'zone' });
|
|
34
|
+
}
|
|
35
|
+
for (const field of REQUIRED_STRING_FIELDS) {
|
|
36
|
+
const v = s[field];
|
|
37
|
+
if (typeof v !== 'string' || v.trim() === '') {
|
|
38
|
+
errors.push({ code: 'STAKE-001', message: `${field} is required.`, path: field });
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
if (s.gate_checks === null || typeof s.gate_checks !== 'object') {
|
|
42
|
+
errors.push({ code: 'STAKE-001', message: 'gate_checks is required and must be a mapping.', path: 'gate_checks' });
|
|
43
|
+
}
|
|
44
|
+
if (!('valid_to' in s) || !(typeof s.valid_to === 'string' || s.valid_to === null)) {
|
|
45
|
+
errors.push({ code: 'STAKE-001', message: 'valid_to is required (an ISO date string or null).', path: 'valid_to' });
|
|
46
|
+
}
|
|
47
|
+
// STAKE-003 — type enum (required field).
|
|
48
|
+
if (typeof s.type !== 'string' || s.type.trim() === '') {
|
|
49
|
+
errors.push({ code: 'STAKE-001', message: 'type is required.', path: 'type' });
|
|
50
|
+
}
|
|
51
|
+
else if (!TYPES.includes(s.type)) {
|
|
52
|
+
errors.push({ code: 'STAKE-003', message: `type "${s.type}" must be one of ${TYPES.join(', ')}.`, path: 'type' });
|
|
53
|
+
}
|
|
54
|
+
// STAKE-002 — actor identity binding (required).
|
|
55
|
+
const actor = s.actor;
|
|
56
|
+
if (typeof actor !== 'string' || actor.trim() === '') {
|
|
57
|
+
errors.push({ code: 'STAKE-002', message: 'actor is required — identity must come from an ACTOR.', path: 'actor' });
|
|
58
|
+
}
|
|
59
|
+
else if (typeOfId(actor) !== 'ACTOR') {
|
|
60
|
+
errors.push({ code: 'STAKE-002', message: `actor "${actor}" must be a typed ACTOR id.`, path: 'actor' });
|
|
61
|
+
}
|
|
62
|
+
else if (options.catalog) {
|
|
63
|
+
const t = options.catalog.typeOf(actor);
|
|
64
|
+
if (t === undefined) {
|
|
65
|
+
errors.push({ code: 'STAKE-002', message: `actor "${actor}" does not resolve to an admitted ACTOR.`, path: 'actor' });
|
|
66
|
+
}
|
|
67
|
+
else if (t !== 'ACTOR') {
|
|
68
|
+
errors.push({ code: 'STAKE-002', message: `actor "${actor}" resolves to a ${t}, not an ACTOR.`, path: 'actor' });
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
// STAKE-001 — interest / influence levels.
|
|
72
|
+
for (const field of ['interest', 'influence']) {
|
|
73
|
+
const v = s[field];
|
|
74
|
+
if (v !== undefined && (typeof v !== 'string' || !LEVELS.includes(v))) {
|
|
75
|
+
errors.push({ code: 'STAKE-001', message: `${field} "${String(v)}" must be one of ${LEVELS.join(', ')}.`, path: field });
|
|
55
76
|
}
|
|
56
77
|
}
|
|
57
78
|
return { valid: errors.length === 0, errors, warnings };
|
|
@@ -5,7 +5,7 @@ function valid() {
|
|
|
5
5
|
notation: 'target-state',
|
|
6
6
|
id: 'TARGET_STATE-EU-LIVE-1',
|
|
7
7
|
name: 'EU operations live — three markets, localised CRM and payments',
|
|
8
|
-
description: 'The structural end-state
|
|
8
|
+
description: 'The structural end-state.',
|
|
9
9
|
capabilities: ['CAPABILITY-V1', 'CAPABILITY-V1.2', 'CAPABILITY-V2'],
|
|
10
10
|
processes: ['PROCESS-CUST-ONBOARD-1', 'PROCESS-ORD-FULFILL-1'],
|
|
11
11
|
applications: ['APPLICATION-CRM-1', 'APPLICATION-OMS-1'],
|
|
@@ -17,46 +17,62 @@ function valid() {
|
|
|
17
17
|
valid_to: null,
|
|
18
18
|
};
|
|
19
19
|
}
|
|
20
|
-
const codes = (input) => validateTargetState(input).errors.map(e => e.code);
|
|
20
|
+
const codes = (input, opts) => validateTargetState(input, opts).errors.map(e => e.code);
|
|
21
21
|
describe('validateTargetState — positive', () => {
|
|
22
|
-
it('accepts
|
|
22
|
+
it('accepts a well-formed target state', () => {
|
|
23
23
|
const r = validateTargetState(valid());
|
|
24
24
|
expect(r.valid, JSON.stringify(r.errors)).toBe(true);
|
|
25
|
-
expect(r.errors).toHaveLength(0);
|
|
26
25
|
});
|
|
27
|
-
it('accepts a
|
|
28
|
-
const
|
|
29
|
-
delete
|
|
30
|
-
delete
|
|
31
|
-
delete
|
|
32
|
-
expect(validateTargetState(
|
|
26
|
+
it('accepts a target state with empty composition lists', () => {
|
|
27
|
+
const t = valid();
|
|
28
|
+
delete t.capabilities;
|
|
29
|
+
delete t.processes;
|
|
30
|
+
delete t.applications;
|
|
31
|
+
expect(validateTargetState(t).valid).toBe(true);
|
|
32
|
+
});
|
|
33
|
+
it('accepts CAPABILITY V/H ids without integer terminal', () => {
|
|
34
|
+
const t = valid();
|
|
35
|
+
t.capabilities = ['CAPABILITY-V1.2.3', 'CAPABILITY-H1.2'];
|
|
36
|
+
expect(validateTargetState(t).valid).toBe(true);
|
|
33
37
|
});
|
|
34
38
|
});
|
|
35
|
-
describe('validateTargetState —
|
|
36
|
-
it('flags a
|
|
37
|
-
|
|
39
|
+
describe('validateTargetState — TSTATE-001 (shape / id grammar)', () => {
|
|
40
|
+
it('flags a missing required envelope field', () => {
|
|
41
|
+
const t = valid();
|
|
42
|
+
delete t.name;
|
|
43
|
+
expect(codes(t)).toContain('TSTATE-001');
|
|
44
|
+
});
|
|
45
|
+
it('flags an id that violates the grammar', () => {
|
|
46
|
+
expect(codes({ ...valid(), id: 'TARGET_STATE-EU-LIVE-001' })).toContain('TSTATE-001');
|
|
47
|
+
expect(codes({ ...valid(), id: 'TS-1' })).toContain('TSTATE-001');
|
|
38
48
|
});
|
|
39
49
|
it('flags a wrong notation tag', () => {
|
|
40
|
-
expect(codes({ ...valid(), notation: '
|
|
50
|
+
expect(codes({ ...valid(), notation: 'target_state' })).toContain('TSTATE-001');
|
|
41
51
|
});
|
|
42
|
-
it('flags
|
|
43
|
-
expect(codes({ ...valid(),
|
|
52
|
+
it('flags a non-array composition list', () => {
|
|
53
|
+
expect(codes({ ...valid(), capabilities: 'CAPABILITY-V1' })).toContain('TSTATE-001');
|
|
44
54
|
});
|
|
45
|
-
it('
|
|
46
|
-
expect(codes(
|
|
55
|
+
it('rejects a non-object', () => {
|
|
56
|
+
expect(codes(null)).toEqual(['TSTATE-001']);
|
|
47
57
|
});
|
|
48
58
|
});
|
|
49
|
-
describe('validateTargetState —
|
|
50
|
-
it('flags a
|
|
51
|
-
expect(codes({ ...valid(), capabilities: ['PROCESS-X-1'] })).toContain('
|
|
59
|
+
describe('validateTargetState — TSTATE-002 (composition TYPEs)', () => {
|
|
60
|
+
it('flags a capabilities entry of the wrong TYPE', () => {
|
|
61
|
+
expect(codes({ ...valid(), capabilities: ['PROCESS-X-1'] })).toContain('TSTATE-002');
|
|
52
62
|
});
|
|
53
|
-
it('flags a
|
|
54
|
-
expect(codes({ ...valid(), processes: ['
|
|
63
|
+
it('flags a processes entry of the wrong TYPE', () => {
|
|
64
|
+
expect(codes({ ...valid(), processes: ['APPLICATION-X-1'] })).toContain('TSTATE-002');
|
|
55
65
|
});
|
|
56
|
-
it('flags
|
|
57
|
-
expect(codes({ ...valid(), applications: ['
|
|
66
|
+
it('flags an applications entry of the wrong TYPE', () => {
|
|
67
|
+
expect(codes({ ...valid(), applications: ['CAPABILITY-V1'] })).toContain('TSTATE-002');
|
|
58
68
|
});
|
|
59
|
-
it('flags
|
|
60
|
-
|
|
69
|
+
it('flags an unresolved id when a catalog is supplied', () => {
|
|
70
|
+
const catalog = { typeOf: () => undefined };
|
|
71
|
+
expect(codes(valid(), { catalog })).toContain('TSTATE-002');
|
|
72
|
+
});
|
|
73
|
+
});
|
|
74
|
+
describe('validateTargetState — TSTATE-003 (forbidden inline goals)', () => {
|
|
75
|
+
it('flags an inline goals field', () => {
|
|
76
|
+
expect(codes({ ...valid(), goals: ['GOAL-EU-1'] })).toContain('TSTATE-003');
|
|
61
77
|
});
|
|
62
78
|
});
|
|
@@ -1,9 +1,14 @@
|
|
|
1
1
|
import type { GateChecks } from '../requirement/types.js';
|
|
2
|
+
/** Composition list field → expected TYPE prefix of each entry. */
|
|
3
|
+
export declare const TARGET_STATE_COMPOSITION_FIELDS: {
|
|
4
|
+
readonly capabilities: "CAPABILITY";
|
|
5
|
+
readonly processes: "PROCESS";
|
|
6
|
+
readonly applications: "APPLICATION";
|
|
7
|
+
};
|
|
2
8
|
export interface TargetState {
|
|
3
9
|
notation: 'target-state';
|
|
4
10
|
id: string;
|
|
5
11
|
name: string;
|
|
6
|
-
/** Composition lists are inline; they are timeless on the element file. */
|
|
7
12
|
capabilities?: string[];
|
|
8
13
|
processes?: string[];
|
|
9
14
|
applications?: string[];
|
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
// TARGET_STATE — implementation-layer
|
|
2
|
-
// Schema: methodology notations/ELEMENT_PRIMITIVES.md §7.
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
1
|
+
// TARGET_STATE — implementation-layer Plateau (ArchiMate).
|
|
2
|
+
// Schema: methodology notations/ELEMENT_PRIMITIVES.md §7.18.
|
|
3
|
+
/** Composition list field → expected TYPE prefix of each entry. */
|
|
4
|
+
export const TARGET_STATE_COMPOSITION_FIELDS = {
|
|
5
|
+
capabilities: 'CAPABILITY',
|
|
6
|
+
processes: 'PROCESS',
|
|
7
|
+
applications: 'APPLICATION',
|
|
8
|
+
};
|
|
@@ -1,2 +1,7 @@
|
|
|
1
1
|
import type { ValidationResult } from '../validation-types.js';
|
|
2
|
-
|
|
2
|
+
import { type CanonCatalog } from '../typed-id.js';
|
|
3
|
+
export interface TargetStateValidateOptions {
|
|
4
|
+
/** When provided, TSTATE-002 enforces that each composition id is admitted. */
|
|
5
|
+
catalog?: CanonCatalog;
|
|
6
|
+
}
|
|
7
|
+
export declare function validateTargetState(input: unknown, options?: TargetStateValidateOptions): ValidationResult;
|