@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.
Files changed (267) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +47 -47
  3. package/dist/__tests__/edge-path.test.js +8 -0
  4. package/dist/activity-card/__tests__/example.test.js +20 -1
  5. package/dist/activity-card/__tests__/layout.test.js +102 -11
  6. package/dist/activity-card/__tests__/resolver.test.js +139 -6
  7. package/dist/activity-card/index.d.ts +1 -1
  8. package/dist/activity-card/layout.d.ts +1 -1
  9. package/dist/activity-card/layout.js +220 -103
  10. package/dist/activity-card/resolver.js +107 -26
  11. package/dist/activity-card/types.d.ts +150 -27
  12. package/dist/activity-card/validate.js +3 -0
  13. package/dist/actor/__tests__/validate.test.js +63 -31
  14. package/dist/actor/index.d.ts +1 -1
  15. package/dist/actor/index.js +1 -1
  16. package/dist/actor/types.d.ts +7 -3
  17. package/dist/actor/types.js +17 -3
  18. package/dist/actor/validate.js +55 -26
  19. package/dist/assertion/types.d.ts +3 -1
  20. package/dist/assertion/types.js +1 -1
  21. package/dist/change/__tests__/validate.test.js +40 -34
  22. package/dist/change/index.d.ts +1 -0
  23. package/dist/change/types.d.ts +1 -1
  24. package/dist/change/types.js +2 -2
  25. package/dist/change/validate.d.ts +6 -1
  26. package/dist/change/validate.js +68 -41
  27. package/dist/compliance/__tests__/classify.test.js +34 -0
  28. package/dist/compliance/__tests__/coverage-metric.test.js +146 -46
  29. package/dist/compliance/__tests__/html.test.js +2 -2
  30. package/dist/compliance/__tests__/impact.test.js +311 -6
  31. package/dist/compliance/classify.d.ts +6 -0
  32. package/dist/compliance/classify.js +9 -1
  33. package/dist/compliance/coverage-metric.d.ts +31 -11
  34. package/dist/compliance/coverage-metric.js +149 -39
  35. package/dist/compliance/html.js +77 -74
  36. package/dist/compliance/impact.d.ts +77 -16
  37. package/dist/compliance/impact.js +193 -25
  38. package/dist/compliance/index.d.ts +2 -2
  39. package/dist/compliance/index.js +1 -1
  40. package/dist/compliance/markdown.js +1 -0
  41. package/dist/compliance/types.d.ts +25 -6
  42. package/dist/edge-path.d.ts +8 -4
  43. package/dist/edge-path.js +11 -6
  44. package/dist/factor/__tests__/validate.test.js +74 -45
  45. package/dist/factor/index.d.ts +3 -2
  46. package/dist/factor/index.js +1 -1
  47. package/dist/factor/types.d.ts +4 -7
  48. package/dist/factor/types.js +10 -5
  49. package/dist/factor/validate.d.ts +6 -1
  50. package/dist/factor/validate.js +68 -50
  51. package/dist/fgca/__tests__/resolver.test.js +185 -0
  52. package/dist/fgca/index.d.ts +2 -0
  53. package/dist/fgca/index.js +1 -0
  54. package/dist/fgca/resolver.d.ts +49 -0
  55. package/dist/fgca/resolver.js +124 -0
  56. package/dist/goals/index.d.ts +1 -1
  57. package/dist/index.d.ts +5 -0
  58. package/dist/index.js +5 -0
  59. package/dist/process-blueprint/__tests__/layout.test.js +37 -0
  60. package/dist/process-blueprint/layout.js +5 -1
  61. package/dist/process-blueprint/types.d.ts +22 -1
  62. package/dist/stakeholder/__tests__/validate.test.js +49 -47
  63. package/dist/stakeholder/index.d.ts +1 -0
  64. package/dist/stakeholder/types.d.ts +3 -4
  65. package/dist/stakeholder/types.js +2 -3
  66. package/dist/stakeholder/validate.d.ts +6 -1
  67. package/dist/stakeholder/validate.js +71 -50
  68. package/dist/target-state/__tests__/validate.test.js +43 -27
  69. package/dist/target-state/index.d.ts +2 -0
  70. package/dist/target-state/index.js +1 -0
  71. package/dist/target-state/types.d.ts +6 -1
  72. package/dist/target-state/types.js +8 -7
  73. package/dist/target-state/validate.d.ts +6 -1
  74. package/dist/target-state/validate.js +69 -45
  75. package/dist/theme/themes.js +69 -69
  76. package/dist/webview/__tests__/entry.test.js +11 -11
  77. package/dist/webview/render-activities.d.ts +3 -1
  78. package/dist/webview/render-activities.js +2 -2
  79. package/dist/webview/render-activity-card.js +104 -77
  80. package/dist/webview/render-fgca.d.ts +4 -0
  81. package/dist/webview/render-fgca.js +2 -5
  82. package/dist/webview/render-goals.d.ts +1 -0
  83. package/dist/webview/render-goals.js +15 -15
  84. package/dist/webview/render-process-blueprint.js +10 -10
  85. package/package.json +40 -40
  86. package/src/__tests__/edge-path.test.ts +58 -46
  87. package/src/__tests__/scope.test.ts +27 -27
  88. package/src/__tests__/yaml-normalize.test.ts +158 -158
  89. package/src/activities/__tests__/cpm.test.ts +164 -164
  90. package/src/activities/__tests__/gantt.test.ts +245 -245
  91. package/src/activities/__tests__/layout.test.ts +112 -112
  92. package/src/activities/__tests__/validate.test.ts +409 -409
  93. package/src/activities/cpm.ts +95 -95
  94. package/src/activities/gantt.ts +276 -276
  95. package/src/activities/index.ts +28 -28
  96. package/src/activities/layout.ts +112 -112
  97. package/src/activities/types.ts +148 -148
  98. package/src/activities/validate.ts +357 -357
  99. package/src/activity-card/__tests__/example.test.ts +85 -66
  100. package/src/activity-card/__tests__/layout.test.ts +169 -63
  101. package/src/activity-card/__tests__/resolver.test.ts +307 -161
  102. package/src/activity-card/__tests__/validate.test.ts +131 -131
  103. package/src/activity-card/index.ts +38 -32
  104. package/src/activity-card/layout.ts +324 -194
  105. package/src/activity-card/resolver.ts +415 -337
  106. package/src/activity-card/types.ts +376 -237
  107. package/src/activity-card/validate.ts +162 -158
  108. package/src/actor/__tests__/validate.test.ts +70 -31
  109. package/src/actor/index.ts +1 -1
  110. package/src/actor/types.ts +21 -7
  111. package/src/actor/validate.ts +59 -27
  112. package/src/applications/__tests__/validate.test.ts +256 -256
  113. package/src/applications/index.ts +11 -11
  114. package/src/applications/types.ts +43 -43
  115. package/src/applications/validate.ts +131 -131
  116. package/src/assertion/__tests__/example.test.ts +37 -37
  117. package/src/assertion/__tests__/validate.test.ts +142 -142
  118. package/src/assertion/index.ts +12 -12
  119. package/src/assertion/types.ts +60 -58
  120. package/src/assertion/validate.ts +145 -145
  121. package/src/blocks/__tests__/layout.test.ts +169 -169
  122. package/src/blocks/__tests__/validate.test.ts +260 -260
  123. package/src/blocks/index.ts +17 -17
  124. package/src/blocks/layout.ts +186 -186
  125. package/src/blocks/types.ts +62 -62
  126. package/src/blocks/validate.ts +206 -206
  127. package/src/capability-map/__tests__/validate.test.ts +238 -238
  128. package/src/capability-map/index.ts +8 -8
  129. package/src/capability-map/types.ts +29 -29
  130. package/src/capability-map/validate.ts +127 -127
  131. package/src/change/__tests__/validate.test.ts +43 -34
  132. package/src/change/index.ts +1 -0
  133. package/src/change/types.ts +5 -3
  134. package/src/change/validate.ts +75 -43
  135. package/src/compliance/__tests__/classify.test.ts +64 -27
  136. package/src/compliance/__tests__/confidence.test.ts +98 -98
  137. package/src/compliance/__tests__/coverage-metric.test.ts +300 -188
  138. package/src/compliance/__tests__/demo-scenario.test.ts +273 -273
  139. package/src/compliance/__tests__/example.test.ts +57 -57
  140. package/src/compliance/__tests__/gap-report.test.ts +128 -128
  141. package/src/compliance/__tests__/html.test.ts +141 -141
  142. package/src/compliance/__tests__/impact.test.ts +840 -481
  143. package/src/compliance/__tests__/markdown.test.ts +94 -94
  144. package/src/compliance/__tests__/views.test.ts +64 -64
  145. package/src/compliance/classify.ts +100 -84
  146. package/src/compliance/confidence.ts +69 -69
  147. package/src/compliance/coverage-metric.ts +404 -263
  148. package/src/compliance/gap-report.ts +94 -94
  149. package/src/compliance/html.ts +298 -295
  150. package/src/compliance/impact.ts +861 -677
  151. package/src/compliance/index.ts +57 -56
  152. package/src/compliance/markdown.ts +136 -135
  153. package/src/compliance/reverse-index.ts +33 -33
  154. package/src/compliance/types.ts +136 -120
  155. package/src/compliance/views.ts +46 -46
  156. package/src/compliance-matrix/__tests__/build.test.ts +200 -200
  157. package/src/compliance-matrix/__tests__/example.test.ts +57 -57
  158. package/src/compliance-matrix/index.ts +11 -11
  159. package/src/compliance-matrix/types.ts +102 -102
  160. package/src/edge-path.ts +50 -44
  161. package/src/factor/__tests__/validate.test.ts +80 -45
  162. package/src/factor/index.ts +3 -7
  163. package/src/factor/types.ts +14 -18
  164. package/src/factor/validate.ts +77 -51
  165. package/src/fgca/__tests__/chain-table.test.ts +172 -172
  166. package/src/fgca/__tests__/layout.test.ts +179 -179
  167. package/src/fgca/__tests__/parse-canonical.test.ts +248 -248
  168. package/src/fgca/__tests__/preview-layout.test.ts +124 -124
  169. package/src/fgca/__tests__/resolver.test.ts +209 -0
  170. package/src/fgca/__tests__/validate.test.ts +142 -142
  171. package/src/fgca/chain-table.ts +225 -225
  172. package/src/fgca/index.ts +47 -45
  173. package/src/fgca/layout.ts +204 -204
  174. package/src/fgca/nodeTypes.ts +11 -11
  175. package/src/fgca/nodes/FGCAActivityNode.tsx +65 -65
  176. package/src/fgca/nodes/FGCAChangeNode.tsx +64 -64
  177. package/src/fgca/nodes/FGCAFactorNode.tsx +64 -64
  178. package/src/fgca/nodes/FGCAGoalNode.tsx +72 -72
  179. package/src/fgca/parse-canonical.ts +400 -400
  180. package/src/fgca/preview-layout.ts +217 -217
  181. package/src/fgca/resolver.ts +157 -0
  182. package/src/fgca/types.ts +50 -50
  183. package/src/fgca/validate.ts +126 -126
  184. package/src/geometry.ts +9 -9
  185. package/src/goals/__tests__/layout.test.ts +175 -175
  186. package/src/goals/__tests__/mutations.test.ts +111 -111
  187. package/src/goals/__tests__/parse-canonical.test.ts +145 -145
  188. package/src/goals/__tests__/validate.test.ts +202 -202
  189. package/src/goals/index.ts +20 -21
  190. package/src/goals/layout.ts +172 -172
  191. package/src/goals/mutations.ts +123 -123
  192. package/src/goals/parse-canonical.ts +286 -286
  193. package/src/goals/types.ts +85 -85
  194. package/src/goals/validate.ts +136 -136
  195. package/src/index.ts +28 -23
  196. package/src/process-blueprint/__tests__/compliance-lane.test.ts +320 -320
  197. package/src/process-blueprint/__tests__/layout.test.ts +240 -195
  198. package/src/process-blueprint/__tests__/validate.test.ts +310 -310
  199. package/src/process-blueprint/index.ts +31 -31
  200. package/src/process-blueprint/layout.ts +535 -531
  201. package/src/process-blueprint/types.ts +263 -242
  202. package/src/process-blueprint/validate.ts +181 -181
  203. package/src/process-map/__tests__/validate.test.ts +223 -223
  204. package/src/process-map/index.ts +10 -10
  205. package/src/process-map/types.ts +36 -36
  206. package/src/process-map/validate.ts +135 -135
  207. package/src/products/__tests__/validate.test.ts +239 -239
  208. package/src/products/index.ts +9 -9
  209. package/src/products/types.ts +31 -31
  210. package/src/products/validate.ts +112 -112
  211. package/src/repo-validate/__tests__/validate-repo.test.ts +149 -149
  212. package/src/repo-validate/index.ts +2 -2
  213. package/src/repo-validate/types.ts +50 -50
  214. package/src/repo-validate/validate-repo.ts +196 -196
  215. package/src/requirement/__tests__/example.test.ts +24 -24
  216. package/src/requirement/__tests__/validate.test.ts +96 -96
  217. package/src/requirement/index.ts +4 -4
  218. package/src/requirement/types.ts +35 -35
  219. package/src/requirement/validate.ts +92 -92
  220. package/src/scenarios/__tests__/validate.test.ts +209 -209
  221. package/src/scenarios/index.ts +15 -15
  222. package/src/scenarios/types.ts +37 -37
  223. package/src/scenarios/validate.ts +122 -122
  224. package/src/schema-version.ts +16 -16
  225. package/src/scope.ts +46 -46
  226. package/src/stakeholder/__tests__/validate.test.ts +51 -47
  227. package/src/stakeholder/index.ts +1 -0
  228. package/src/stakeholder/types.ts +7 -7
  229. package/src/stakeholder/validate.ts +79 -52
  230. package/src/target-state/__tests__/validate.test.ts +48 -27
  231. package/src/target-state/index.ts +2 -0
  232. package/src/target-state/types.ts +11 -7
  233. package/src/target-state/validate.ts +76 -46
  234. package/src/theme/index.ts +4 -4
  235. package/src/theme/themes.ts +237 -237
  236. package/src/theme/tokens.ts +133 -133
  237. package/src/typed-id.ts +56 -56
  238. package/src/validation-types.ts +36 -36
  239. package/src/webview/__tests__/entry-notations.test.ts +77 -77
  240. package/src/webview/__tests__/entry.test.ts +64 -64
  241. package/src/webview/__tests__/render-goals.test.ts +72 -72
  242. package/src/webview/entry.ts +292 -292
  243. package/src/webview/render-activities.ts +5 -3
  244. package/src/webview/render-activity-card.ts +266 -234
  245. package/src/webview/render-fgca.ts +6 -5
  246. package/src/webview/render-goals.ts +111 -110
  247. package/src/webview/render-process-blueprint.ts +207 -207
  248. package/src/webview/styles.css +322 -323
  249. package/src/yaml-normalize.ts +56 -56
  250. package/dist/element-envelope.d.ts +0 -15
  251. package/dist/element-envelope.js +0 -55
  252. package/dist/issues/__tests__/layout.test.js +0 -62
  253. package/dist/issues/__tests__/validate.test.d.ts +0 -1
  254. package/dist/issues/__tests__/validate.test.js +0 -82
  255. package/dist/issues/index.d.ts +0 -4
  256. package/dist/issues/index.js +0 -2
  257. package/dist/issues/layout.d.ts +0 -10
  258. package/dist/issues/layout.js +0 -82
  259. package/dist/issues/types.d.ts +0 -61
  260. package/dist/issues/types.js +0 -6
  261. package/dist/issues/validate.d.ts +0 -3
  262. package/dist/issues/validate.js +0 -143
  263. package/dist/webview/transitrix-render.css +0 -323
  264. package/dist/webview/transitrix-render.js +0 -6452
  265. package/dist/webview/transitrix-render.js.map +0 -7
  266. package/src/element-envelope.ts +0 -76
  267. /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 ASPECT_CATEGORIES) {
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 EU customer personal data.',
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 the worked-example STAKEHOLDER-DPA-1', () => {
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 (no concern / interest / influence)', () => {
30
- const r = valid();
31
- delete r.concern;
32
- delete r.interest;
33
- delete r.influence;
34
- expect(validateStakeholder(r).valid).toBe(true);
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
- describe('validateStakeholder — STAKEHOLDER-001 (envelope / shape)', () => {
38
- it('flags a non-object', () => {
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
- it('flags a wrong notation tag', () => {
42
- expect(codes({ ...valid(), notation: 'stake' })).toContain('STAKEHOLDER-001');
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 with the wrong TYPE prefix', () => {
45
- expect(codes({ ...valid(), id: 'ACTOR-DPA-1' })).toContain('STAKEHOLDER-001');
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
- describe('validateStakeholder — STAKEHOLDER-002 (type enum)', () => {
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 a type outside internal/external', () => {
55
- expect(codes({ ...valid(), type: 'regulator' })).toContain('STAKEHOLDER-002');
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('accepts both internal and external', () => {
58
- for (const t of ['internal', 'external']) {
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 — STAKEHOLDER-003 (actor binding)', () => {
66
+ describe('validateStakeholder — STAKE-002 (actor binding)', () => {
64
67
  it('flags a missing actor', () => {
65
- const r = valid();
66
- delete r.actor;
67
- expect(codes(r)).toContain('STAKEHOLDER-003');
68
+ const s = valid();
69
+ delete s.actor;
70
+ expect(codes(s)).toContain('STAKE-002');
68
71
  });
69
- it('flags an actor that is not an ACTOR typed id', () => {
70
- expect(codes({ ...valid(), actor: 'ROLE-CEO-1' })).toContain('STAKEHOLDER-003');
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
- describe('validateStakeholder — STAKEHOLDER-004 (level enums)', () => {
75
- it('flags an interest outside high/medium/low', () => {
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 influence outside high/medium/low', () => {
79
- expect(codes({ ...valid(), influence: 'extreme' })).toContain('STAKEHOLDER-004');
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
- it('accepts each permitted level', () => {
82
- for (const l of ['high', 'medium', 'low']) {
83
- expect(validateStakeholder({ ...valid(), interest: l, influence: l }).valid).toBe(true);
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,3 +1,4 @@
1
1
  export type { Stakeholder, StakeholderType, StakeholderLevel } from './types.js';
2
2
  export { STAKEHOLDER_TYPES, STAKEHOLDER_LEVELS } from './types.js';
3
3
  export { validateStakeholder } from './validate.js';
4
+ export type { StakeholderValidateOptions } from './validate.js';
@@ -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 StakeholderLevel = 'high' | 'medium' | 'low';
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
- /** Required ACTOR-… typed id — identity binding (never inline). */
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.15 +
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
- export declare function validateStakeholder(input: unknown): ValidationResult;
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/ELEMENT_PRIMITIVES.md §7.15
2
- // + notations/elements/20-stakeholders.md.
1
+ // STAKEHOLDER validator — methodology notations/elements/20-stakeholders.md §5.
3
2
  //
4
- // Implements STAKEHOLDER-001..004. Stake-in-a-specific-object lives on
5
- // `stakeholding` REL records (elements/17-relations.md §3) and is out of
6
- // scope for this single-artefact validator.
7
- import { typeOfId } from '../typed-id.js';
8
- import { validateElementEnvelope } from '../element-envelope.js';
9
- import { STAKEHOLDER_LEVELS, STAKEHOLDER_TYPES } from './types.js';
10
- export function validateStakeholder(input) {
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
- const { record, errors: envErrors } = validateElementEnvelope(input, {
14
- notation: 'stakeholder',
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
- // STAKEHOLDER-002 — type subtype required.
22
- if (record.type === undefined || record.type === null) {
23
- errors.push({ code: 'STAKEHOLDER-002', message: 'type is required (internal | external).', path: 'type' });
24
- }
25
- else if (!STAKEHOLDER_TYPES.includes(record.type)) {
26
- errors.push({
27
- code: 'STAKEHOLDER-002',
28
- message: `type "${String(record.type)}" must be one of ${STAKEHOLDER_TYPES.join(', ')}.`,
29
- path: 'type',
30
- });
31
- }
32
- // STAKEHOLDER-003 — actor identity binding (REQUIRED, must be ACTOR-…).
33
- if (record.actor === undefined || record.actor === null || record.actor === '') {
34
- errors.push({
35
- code: 'STAKEHOLDER-003',
36
- message: 'actor is required — identity lives in an ACTOR-… record, never inline.',
37
- path: 'actor',
38
- });
39
- }
40
- else if (typeOfId(record.actor) !== 'ACTOR') {
41
- errors.push({
42
- code: 'STAKEHOLDER-003',
43
- message: `actor "${String(record.actor)}" must be an ACTOR typed ID.`,
44
- path: 'actor',
45
- });
46
- }
47
- // STAKEHOLDER-004 — interest / influence level enums (optional fields).
48
- for (const f of ['interest', 'influence']) {
49
- if (record[f] !== undefined && !STAKEHOLDER_LEVELS.includes(record[f])) {
50
- errors.push({
51
- code: 'STAKEHOLDER-004',
52
- message: `${f} "${String(record[f])}" must be one of ${STAKEHOLDER_LEVELS.join(', ')}.`,
53
- path: f,
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 in which Acme operates in three EU markets.',
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 the worked-example TARGET_STATE-EU-LIVE-1', () => {
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 minimal target state (name + envelope only)', () => {
28
- const r = valid();
29
- delete r.capabilities;
30
- delete r.processes;
31
- delete r.applications;
32
- expect(validateTargetState(r).valid).toBe(true);
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 — TARGET_STATE-001 (envelope / shape)', () => {
36
- it('flags a non-object', () => {
37
- expect(codes(null)).toEqual(['TARGET_STATE-001']);
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: 'plateau' })).toContain('TARGET_STATE-001');
50
+ expect(codes({ ...valid(), notation: 'target_state' })).toContain('TSTATE-001');
41
51
  });
42
- it('flags an id with the wrong TYPE prefix', () => {
43
- expect(codes({ ...valid(), id: 'SCENARIO-EU-LIVE-1' })).toContain('TARGET_STATE-001');
52
+ it('flags a non-array composition list', () => {
53
+ expect(codes({ ...valid(), capabilities: 'CAPABILITY-V1' })).toContain('TSTATE-001');
44
54
  });
45
- it('flags an inline goals field (it belongs on a REL)', () => {
46
- expect(codes({ ...valid(), goals: ['GOAL-EU-1'] })).toContain('TARGET_STATE-001');
55
+ it('rejects a non-object', () => {
56
+ expect(codes(null)).toEqual(['TSTATE-001']);
47
57
  });
48
58
  });
49
- describe('validateTargetState — TARGET_STATE-002 (composition refs)', () => {
50
- it('flags a non-CAPABILITY id in capabilities', () => {
51
- expect(codes({ ...valid(), capabilities: ['PROCESS-X-1'] })).toContain('TARGET_STATE-002');
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 non-PROCESS id in processes', () => {
54
- expect(codes({ ...valid(), processes: ['CAPABILITY-V1'] })).toContain('TARGET_STATE-002');
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 a non-APPLICATION id in applications', () => {
57
- expect(codes({ ...valid(), applications: ['PRODUCT-X-1'] })).toContain('TARGET_STATE-002');
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 a composition field that is not an array', () => {
60
- expect(codes({ ...valid(), capabilities: 'CAPABILITY-V1' })).toContain('TARGET_STATE-002');
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,2 +1,4 @@
1
1
  export type { TargetState } from './types.js';
2
+ export { TARGET_STATE_COMPOSITION_FIELDS } from './types.js';
2
3
  export { validateTargetState } from './validate.js';
4
+ export type { TargetStateValidateOptions } from './validate.js';
@@ -1 +1,2 @@
1
+ export { TARGET_STATE_COMPOSITION_FIELDS } from './types.js';
1
2
  export { validateTargetState } from './validate.js';
@@ -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 plateau primitive (ArchiMate Plateau).
2
- // Schema: methodology notations/ELEMENT_PRIMITIVES.md §7.17 + envelope §3.
3
- //
4
- // The id TYPE prefix is `TARGET_STATE` (underscore — uppercase identifier in
5
- // IDS_AND_REFERENCES.md §3.1). The notation tag is the lowercased hyphenated
6
- // short name `target-state` (per ELEMENT_PRIMITIVES.md §4).
7
- export {};
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
- export declare function validateTargetState(input: unknown): ValidationResult;
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;