@transitrix/diagrams 1.0.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 -0
- package/README.md +47 -0
- package/dist/__tests__/edge-path.test.d.ts +1 -0
- package/dist/__tests__/edge-path.test.js +39 -0
- package/dist/__tests__/scope.test.d.ts +1 -0
- package/dist/__tests__/scope.test.js +23 -0
- package/dist/__tests__/yaml-normalize.test.d.ts +1 -0
- package/dist/__tests__/yaml-normalize.test.js +148 -0
- package/dist/activities/__tests__/cpm.test.d.ts +1 -0
- package/dist/activities/__tests__/cpm.test.js +146 -0
- package/dist/activities/__tests__/gantt.test.d.ts +1 -0
- package/dist/activities/__tests__/gantt.test.js +224 -0
- package/dist/activities/__tests__/layout.test.d.ts +1 -0
- package/dist/activities/__tests__/layout.test.js +98 -0
- package/dist/activities/__tests__/validate.test.d.ts +1 -0
- package/dist/activities/__tests__/validate.test.js +363 -0
- package/dist/activities/cpm.d.ts +2 -0
- package/dist/activities/cpm.js +86 -0
- package/dist/activities/gantt.d.ts +6 -0
- package/dist/activities/gantt.js +250 -0
- package/dist/activities/index.d.ts +5 -0
- package/dist/activities/index.js +4 -0
- package/dist/activities/layout.d.ts +2 -0
- package/dist/activities/layout.js +103 -0
- package/dist/activities/types.d.ts +125 -0
- package/dist/activities/types.js +1 -0
- package/dist/activities/validate.d.ts +2 -0
- package/dist/activities/validate.js +326 -0
- package/dist/activity-card/__tests__/example.test.d.ts +1 -0
- package/dist/activity-card/__tests__/example.test.js +56 -0
- package/dist/activity-card/__tests__/layout.test.d.ts +1 -0
- package/dist/activity-card/__tests__/layout.test.js +57 -0
- package/dist/activity-card/__tests__/resolver.test.d.ts +1 -0
- package/dist/activity-card/__tests__/resolver.test.js +146 -0
- package/dist/activity-card/__tests__/validate.test.d.ts +1 -0
- package/dist/activity-card/__tests__/validate.test.js +116 -0
- package/dist/activity-card/index.d.ts +5 -0
- package/dist/activity-card/index.js +3 -0
- package/dist/activity-card/layout.d.ts +7 -0
- package/dist/activity-card/layout.js +167 -0
- package/dist/activity-card/resolver.d.ts +7 -0
- package/dist/activity-card/resolver.js +310 -0
- package/dist/activity-card/types.d.ts +175 -0
- package/dist/activity-card/types.js +20 -0
- package/dist/activity-card/validate.d.ts +3 -0
- package/dist/activity-card/validate.js +145 -0
- package/dist/actor/__tests__/validate.test.d.ts +1 -0
- package/dist/actor/__tests__/validate.test.js +57 -0
- package/dist/actor/index.d.ts +3 -0
- package/dist/actor/index.js +2 -0
- package/dist/actor/types.d.ts +20 -0
- package/dist/actor/types.js +4 -0
- package/dist/actor/validate.d.ts +2 -0
- package/dist/actor/validate.js +34 -0
- package/dist/applications/__tests__/validate.test.d.ts +1 -0
- package/dist/applications/__tests__/validate.test.js +223 -0
- package/dist/applications/index.d.ts +2 -0
- package/dist/applications/index.js +1 -0
- package/dist/applications/types.d.ts +39 -0
- package/dist/applications/types.js +1 -0
- package/dist/applications/validate.d.ts +3 -0
- package/dist/applications/validate.js +109 -0
- package/dist/assertion/__tests__/example.test.d.ts +1 -0
- package/dist/assertion/__tests__/example.test.js +32 -0
- package/dist/assertion/__tests__/validate.test.d.ts +1 -0
- package/dist/assertion/__tests__/validate.test.js +130 -0
- package/dist/assertion/index.d.ts +4 -0
- package/dist/assertion/index.js +2 -0
- package/dist/assertion/types.d.ts +43 -0
- package/dist/assertion/types.js +7 -0
- package/dist/assertion/validate.d.ts +9 -0
- package/dist/assertion/validate.js +137 -0
- package/dist/blocks/__tests__/layout.test.d.ts +1 -0
- package/dist/blocks/__tests__/layout.test.js +153 -0
- package/dist/blocks/__tests__/validate.test.d.ts +1 -0
- package/dist/blocks/__tests__/validate.test.js +235 -0
- package/dist/blocks/index.d.ts +4 -0
- package/dist/blocks/index.js +2 -0
- package/dist/blocks/layout.d.ts +4 -0
- package/dist/blocks/layout.js +145 -0
- package/dist/blocks/types.d.ts +56 -0
- package/dist/blocks/types.js +1 -0
- package/dist/blocks/validate.d.ts +9 -0
- package/dist/blocks/validate.js +186 -0
- package/dist/capability-map/__tests__/validate.test.d.ts +1 -0
- package/dist/capability-map/__tests__/validate.test.js +212 -0
- package/dist/capability-map/index.d.ts +2 -0
- package/dist/capability-map/index.js +1 -0
- package/dist/capability-map/types.d.ts +26 -0
- package/dist/capability-map/types.js +1 -0
- package/dist/capability-map/validate.d.ts +3 -0
- package/dist/capability-map/validate.js +103 -0
- package/dist/change/__tests__/validate.test.d.ts +1 -0
- package/dist/change/__tests__/validate.test.js +73 -0
- package/dist/change/index.d.ts +2 -0
- package/dist/change/index.js +1 -0
- package/dist/change/types.d.ts +17 -0
- package/dist/change/types.js +3 -0
- package/dist/change/validate.d.ts +2 -0
- package/dist/change/validate.js +57 -0
- package/dist/compliance/__tests__/classify.test.d.ts +1 -0
- package/dist/compliance/__tests__/classify.test.js +24 -0
- package/dist/compliance/__tests__/confidence.test.d.ts +1 -0
- package/dist/compliance/__tests__/confidence.test.js +78 -0
- package/dist/compliance/__tests__/coverage-metric.test.d.ts +1 -0
- package/dist/compliance/__tests__/coverage-metric.test.js +164 -0
- package/dist/compliance/__tests__/demo-scenario.test.d.ts +1 -0
- package/dist/compliance/__tests__/demo-scenario.test.js +226 -0
- package/dist/compliance/__tests__/example.test.d.ts +1 -0
- package/dist/compliance/__tests__/example.test.js +51 -0
- package/dist/compliance/__tests__/gap-report.test.d.ts +1 -0
- package/dist/compliance/__tests__/gap-report.test.js +113 -0
- package/dist/compliance/__tests__/html.test.d.ts +1 -0
- package/dist/compliance/__tests__/html.test.js +122 -0
- package/dist/compliance/__tests__/impact.test.d.ts +1 -0
- package/dist/compliance/__tests__/impact.test.js +410 -0
- package/dist/compliance/__tests__/markdown.test.d.ts +1 -0
- package/dist/compliance/__tests__/markdown.test.js +85 -0
- package/dist/compliance/__tests__/views.test.d.ts +1 -0
- package/dist/compliance/__tests__/views.test.js +59 -0
- package/dist/compliance/classify.d.ts +27 -0
- package/dist/compliance/classify.js +60 -0
- package/dist/compliance/confidence.d.ts +27 -0
- package/dist/compliance/confidence.js +43 -0
- package/dist/compliance/coverage-metric.d.ts +74 -0
- package/dist/compliance/coverage-metric.js +181 -0
- package/dist/compliance/gap-report.d.ts +20 -0
- package/dist/compliance/gap-report.js +64 -0
- package/dist/compliance/html.d.ts +22 -0
- package/dist/compliance/html.js +256 -0
- package/dist/compliance/impact.d.ts +251 -0
- package/dist/compliance/impact.js +464 -0
- package/dist/compliance/index.d.ts +16 -0
- package/dist/compliance/index.js +9 -0
- package/dist/compliance/markdown.d.ts +18 -0
- package/dist/compliance/markdown.js +129 -0
- package/dist/compliance/reverse-index.d.ts +8 -0
- package/dist/compliance/reverse-index.js +30 -0
- package/dist/compliance/types.d.ts +98 -0
- package/dist/compliance/types.js +5 -0
- package/dist/compliance/views.d.ts +14 -0
- package/dist/compliance/views.js +35 -0
- package/dist/compliance-matrix/__tests__/build.test.d.ts +1 -0
- package/dist/compliance-matrix/__tests__/build.test.js +183 -0
- package/dist/compliance-matrix/__tests__/example.test.d.ts +1 -0
- package/dist/compliance-matrix/__tests__/example.test.js +49 -0
- package/dist/compliance-matrix/build.d.ts +18 -0
- package/dist/compliance-matrix/build.js +0 -0
- package/dist/compliance-matrix/index.d.ts +2 -0
- package/dist/compliance-matrix/index.js +1 -0
- package/dist/compliance-matrix/types.d.ts +86 -0
- package/dist/compliance-matrix/types.js +8 -0
- package/dist/confidence/__tests__/score.test.d.ts +1 -0
- package/dist/confidence/__tests__/score.test.js +188 -0
- package/dist/confidence/index.d.ts +2 -0
- package/dist/confidence/index.js +1 -0
- package/dist/confidence/score.d.ts +62 -0
- package/dist/confidence/score.js +215 -0
- package/dist/confidence/types.d.ts +79 -0
- package/dist/confidence/types.js +6 -0
- package/dist/edge-path.d.ts +18 -0
- package/dist/edge-path.js +35 -0
- package/dist/element-envelope.d.ts +15 -0
- package/dist/element-envelope.js +55 -0
- package/dist/factor/__tests__/validate.test.d.ts +1 -0
- package/dist/factor/__tests__/validate.test.js +83 -0
- package/dist/factor/index.d.ts +3 -0
- package/dist/factor/index.js +2 -0
- package/dist/factor/types.d.ts +23 -0
- package/dist/factor/types.js +6 -0
- package/dist/factor/validate.d.ts +2 -0
- package/dist/factor/validate.js +69 -0
- package/dist/fgca/__tests__/chain-table.test.d.ts +1 -0
- package/dist/fgca/__tests__/chain-table.test.js +158 -0
- package/dist/fgca/__tests__/layout.test.d.ts +1 -0
- package/dist/fgca/__tests__/layout.test.js +140 -0
- package/dist/fgca/__tests__/parse-canonical.test.d.ts +1 -0
- package/dist/fgca/__tests__/parse-canonical.test.js +224 -0
- package/dist/fgca/__tests__/preview-layout.test.d.ts +1 -0
- package/dist/fgca/__tests__/preview-layout.test.js +106 -0
- package/dist/fgca/__tests__/validate.test.d.ts +1 -0
- package/dist/fgca/__tests__/validate.test.js +125 -0
- package/dist/fgca/chain-table.d.ts +36 -0
- package/dist/fgca/chain-table.js +177 -0
- package/dist/fgca/index.d.ts +16 -0
- package/dist/fgca/index.js +11 -0
- package/dist/fgca/layout.d.ts +27 -0
- package/dist/fgca/layout.js +156 -0
- package/dist/fgca/nodeTypes.d.ts +6 -0
- package/dist/fgca/nodeTypes.js +10 -0
- package/dist/fgca/nodes/FGCAActivityNode.d.ts +13 -0
- package/dist/fgca/nodes/FGCAActivityNode.js +35 -0
- package/dist/fgca/nodes/FGCAChangeNode.d.ts +12 -0
- package/dist/fgca/nodes/FGCAChangeNode.js +35 -0
- package/dist/fgca/nodes/FGCAFactorNode.d.ts +12 -0
- package/dist/fgca/nodes/FGCAFactorNode.js +35 -0
- package/dist/fgca/nodes/FGCAGoalNode.d.ts +14 -0
- package/dist/fgca/nodes/FGCAGoalNode.js +40 -0
- package/dist/fgca/parse-canonical.d.ts +58 -0
- package/dist/fgca/parse-canonical.js +339 -0
- package/dist/fgca/preview-layout.d.ts +87 -0
- package/dist/fgca/preview-layout.js +122 -0
- package/dist/fgca/types.d.ts +39 -0
- package/dist/fgca/types.js +7 -0
- package/dist/fgca/validate.d.ts +14 -0
- package/dist/fgca/validate.js +108 -0
- package/dist/geometry.d.ts +7 -0
- package/dist/geometry.js +2 -0
- package/dist/goals/__tests__/layout.test.d.ts +1 -0
- package/dist/goals/__tests__/layout.test.js +153 -0
- package/dist/goals/__tests__/mutations.test.d.ts +1 -0
- package/dist/goals/__tests__/mutations.test.js +95 -0
- package/dist/goals/__tests__/parse-canonical.test.d.ts +1 -0
- package/dist/goals/__tests__/parse-canonical.test.js +129 -0
- package/dist/goals/__tests__/validate.test.d.ts +1 -0
- package/dist/goals/__tests__/validate.test.js +183 -0
- package/dist/goals/index.d.ts +6 -0
- package/dist/goals/index.js +4 -0
- package/dist/goals/layout.d.ts +11 -0
- package/dist/goals/layout.js +147 -0
- package/dist/goals/mutations.d.ts +6 -0
- package/dist/goals/mutations.js +116 -0
- package/dist/goals/parse-canonical.d.ts +29 -0
- package/dist/goals/parse-canonical.js +257 -0
- package/dist/goals/types.d.ts +71 -0
- package/dist/goals/types.js +1 -0
- package/dist/goals/validate.d.ts +2 -0
- package/dist/goals/validate.js +122 -0
- package/dist/index.d.ts +23 -0
- package/dist/index.js +23 -0
- package/dist/issues/__tests__/layout.test.d.ts +1 -0
- package/dist/issues/__tests__/layout.test.js +62 -0
- package/dist/issues/__tests__/validate.test.d.ts +1 -0
- package/dist/issues/__tests__/validate.test.js +82 -0
- package/dist/issues/index.d.ts +4 -0
- package/dist/issues/index.js +2 -0
- package/dist/issues/layout.d.ts +10 -0
- package/dist/issues/layout.js +82 -0
- package/dist/issues/types.d.ts +61 -0
- package/dist/issues/types.js +6 -0
- package/dist/issues/validate.d.ts +3 -0
- package/dist/issues/validate.js +143 -0
- package/dist/process-blueprint/__tests__/compliance-lane.test.d.ts +1 -0
- package/dist/process-blueprint/__tests__/compliance-lane.test.js +272 -0
- package/dist/process-blueprint/__tests__/layout.test.d.ts +1 -0
- package/dist/process-blueprint/__tests__/layout.test.js +159 -0
- package/dist/process-blueprint/__tests__/validate.test.d.ts +1 -0
- package/dist/process-blueprint/__tests__/validate.test.js +280 -0
- package/dist/process-blueprint/index.d.ts +4 -0
- package/dist/process-blueprint/index.js +2 -0
- package/dist/process-blueprint/layout.d.ts +2 -0
- package/dist/process-blueprint/layout.js +416 -0
- package/dist/process-blueprint/types.d.ts +220 -0
- package/dist/process-blueprint/types.js +1 -0
- package/dist/process-blueprint/validate.d.ts +3 -0
- package/dist/process-blueprint/validate.js +165 -0
- package/dist/process-map/__tests__/validate.test.d.ts +1 -0
- package/dist/process-map/__tests__/validate.test.js +199 -0
- package/dist/process-map/index.d.ts +2 -0
- package/dist/process-map/index.js +1 -0
- package/dist/process-map/types.d.ts +32 -0
- package/dist/process-map/types.js +1 -0
- package/dist/process-map/validate.d.ts +3 -0
- package/dist/process-map/validate.js +115 -0
- package/dist/products/__tests__/validate.test.d.ts +1 -0
- package/dist/products/__tests__/validate.test.js +210 -0
- package/dist/products/index.d.ts +2 -0
- package/dist/products/index.js +1 -0
- package/dist/products/types.d.ts +28 -0
- package/dist/products/types.js +1 -0
- package/dist/products/validate.d.ts +3 -0
- package/dist/products/validate.js +93 -0
- package/dist/repo-validate/__tests__/validate-repo.test.d.ts +1 -0
- package/dist/repo-validate/__tests__/validate-repo.test.js +132 -0
- package/dist/repo-validate/index.d.ts +2 -0
- package/dist/repo-validate/index.js +1 -0
- package/dist/repo-validate/types.d.ts +34 -0
- package/dist/repo-validate/types.js +14 -0
- package/dist/repo-validate/validate-repo.d.ts +8 -0
- package/dist/repo-validate/validate-repo.js +189 -0
- package/dist/requirement/__tests__/example.test.d.ts +1 -0
- package/dist/requirement/__tests__/example.test.js +21 -0
- package/dist/requirement/__tests__/validate.test.d.ts +1 -0
- package/dist/requirement/__tests__/validate.test.js +80 -0
- package/dist/requirement/index.d.ts +4 -0
- package/dist/requirement/index.js +2 -0
- package/dist/requirement/types.d.ts +25 -0
- package/dist/requirement/types.js +4 -0
- package/dist/requirement/validate.d.ts +7 -0
- package/dist/requirement/validate.js +81 -0
- package/dist/scenarios/__tests__/validate.test.d.ts +1 -0
- package/dist/scenarios/__tests__/validate.test.js +183 -0
- package/dist/scenarios/index.d.ts +2 -0
- package/dist/scenarios/index.js +1 -0
- package/dist/scenarios/types.d.ts +45 -0
- package/dist/scenarios/types.js +1 -0
- package/dist/scenarios/validate.d.ts +3 -0
- package/dist/scenarios/validate.js +110 -0
- package/dist/schema-version.d.ts +16 -0
- package/dist/schema-version.js +16 -0
- package/dist/scope.d.ts +23 -0
- package/dist/scope.js +38 -0
- package/dist/stakeholder/__tests__/validate.test.d.ts +1 -0
- package/dist/stakeholder/__tests__/validate.test.js +86 -0
- package/dist/stakeholder/index.d.ts +3 -0
- package/dist/stakeholder/index.js +2 -0
- package/dist/stakeholder/types.d.ts +24 -0
- package/dist/stakeholder/types.js +5 -0
- package/dist/stakeholder/validate.d.ts +2 -0
- package/dist/stakeholder/validate.js +58 -0
- package/dist/target-state/__tests__/validate.test.d.ts +1 -0
- package/dist/target-state/__tests__/validate.test.js +62 -0
- package/dist/target-state/index.d.ts +2 -0
- package/dist/target-state/index.js +1 -0
- package/dist/target-state/types.d.ts +18 -0
- package/dist/target-state/types.js +7 -0
- package/dist/target-state/validate.d.ts +2 -0
- package/dist/target-state/validate.js +61 -0
- package/dist/theme/index.d.ts +4 -0
- package/dist/theme/index.js +2 -0
- package/dist/theme/themes.d.ts +16 -0
- package/dist/theme/themes.js +213 -0
- package/dist/theme/tokens.d.ts +158 -0
- package/dist/theme/tokens.js +105 -0
- package/dist/typed-id.d.ts +20 -0
- package/dist/typed-id.js +38 -0
- package/dist/validation-types.d.ts +34 -0
- package/dist/validation-types.js +1 -0
- package/dist/webview/__tests__/entry-notations.test.d.ts +1 -0
- package/dist/webview/__tests__/entry-notations.test.js +62 -0
- package/dist/webview/__tests__/entry.test.d.ts +1 -0
- package/dist/webview/__tests__/entry.test.js +56 -0
- package/dist/webview/__tests__/render-goals.test.d.ts +1 -0
- package/dist/webview/__tests__/render-goals.test.js +65 -0
- package/dist/webview/entry.d.ts +38 -0
- package/dist/webview/entry.js +182 -0
- package/dist/webview/render-activities.d.ts +24 -0
- package/dist/webview/render-activities.js +127 -0
- package/dist/webview/render-activity-card.d.ts +5 -0
- package/dist/webview/render-activity-card.js +168 -0
- package/dist/webview/render-applications.d.ts +11 -0
- package/dist/webview/render-applications.js +105 -0
- package/dist/webview/render-blocks.d.ts +5 -0
- package/dist/webview/render-blocks.js +71 -0
- package/dist/webview/render-capability-map.d.ts +7 -0
- package/dist/webview/render-capability-map.js +88 -0
- package/dist/webview/render-fgca.d.ts +8 -0
- package/dist/webview/render-fgca.js +94 -0
- package/dist/webview/render-goals.d.ts +6 -0
- package/dist/webview/render-goals.js +92 -0
- package/dist/webview/render-process-blueprint.d.ts +5 -0
- package/dist/webview/render-process-blueprint.js +135 -0
- package/dist/webview/render-process-map.d.ts +7 -0
- package/dist/webview/render-process-map.js +82 -0
- package/dist/webview/render-products.d.ts +7 -0
- package/dist/webview/render-products.js +81 -0
- package/dist/webview/render-scenarios.d.ts +7 -0
- package/dist/webview/render-scenarios.js +75 -0
- package/dist/webview/render-util.d.ts +16 -0
- package/dist/webview/render-util.js +31 -0
- package/dist/webview/transitrix-render.css +323 -0
- package/dist/webview/transitrix-render.js +6452 -0
- package/dist/webview/transitrix-render.js.map +7 -0
- package/dist/yaml-normalize.d.ts +20 -0
- package/dist/yaml-normalize.js +57 -0
- package/package.json +40 -0
- package/src/__tests__/edge-path.test.ts +46 -0
- package/src/__tests__/scope.test.ts +27 -0
- package/src/__tests__/yaml-normalize.test.ts +158 -0
- package/src/activities/__tests__/cpm.test.ts +164 -0
- package/src/activities/__tests__/gantt.test.ts +245 -0
- package/src/activities/__tests__/layout.test.ts +112 -0
- package/src/activities/__tests__/validate.test.ts +409 -0
- package/src/activities/cpm.ts +95 -0
- package/src/activities/gantt.ts +276 -0
- package/src/activities/index.ts +28 -0
- package/src/activities/layout.ts +112 -0
- package/src/activities/types.ts +148 -0
- package/src/activities/validate.ts +357 -0
- package/src/activity-card/__tests__/example.test.ts +66 -0
- package/src/activity-card/__tests__/layout.test.ts +63 -0
- package/src/activity-card/__tests__/resolver.test.ts +161 -0
- package/src/activity-card/__tests__/validate.test.ts +131 -0
- package/src/activity-card/index.ts +32 -0
- package/src/activity-card/layout.ts +194 -0
- package/src/activity-card/resolver.ts +337 -0
- package/src/activity-card/types.ts +237 -0
- package/src/activity-card/validate.ts +158 -0
- package/src/actor/__tests__/validate.test.ts +67 -0
- package/src/actor/index.ts +3 -0
- package/src/actor/types.ts +29 -0
- package/src/actor/validate.ts +38 -0
- package/src/applications/__tests__/validate.test.ts +256 -0
- package/src/applications/index.ts +11 -0
- package/src/applications/types.ts +43 -0
- package/src/applications/validate.ts +131 -0
- package/src/assertion/__tests__/example.test.ts +37 -0
- package/src/assertion/__tests__/validate.test.ts +142 -0
- package/src/assertion/index.ts +12 -0
- package/src/assertion/types.ts +58 -0
- package/src/assertion/validate.ts +145 -0
- package/src/blocks/__tests__/layout.test.ts +169 -0
- package/src/blocks/__tests__/validate.test.ts +260 -0
- package/src/blocks/index.ts +17 -0
- package/src/blocks/layout.ts +186 -0
- package/src/blocks/types.ts +62 -0
- package/src/blocks/validate.ts +206 -0
- package/src/capability-map/__tests__/validate.test.ts +238 -0
- package/src/capability-map/index.ts +8 -0
- package/src/capability-map/types.ts +29 -0
- package/src/capability-map/validate.ts +127 -0
- package/src/change/__tests__/validate.test.ts +88 -0
- package/src/change/index.ts +2 -0
- package/src/change/types.ts +23 -0
- package/src/change/validate.ts +61 -0
- package/src/compliance/__tests__/classify.test.ts +27 -0
- package/src/compliance/__tests__/confidence.test.ts +98 -0
- package/src/compliance/__tests__/coverage-metric.test.ts +188 -0
- package/src/compliance/__tests__/demo-scenario.test.ts +273 -0
- package/src/compliance/__tests__/example.test.ts +57 -0
- package/src/compliance/__tests__/gap-report.test.ts +129 -0
- package/src/compliance/__tests__/html.test.ts +142 -0
- package/src/compliance/__tests__/impact.test.ts +482 -0
- package/src/compliance/__tests__/markdown.test.ts +95 -0
- package/src/compliance/__tests__/views.test.ts +64 -0
- package/src/compliance/classify.ts +84 -0
- package/src/compliance/confidence.ts +69 -0
- package/src/compliance/coverage-metric.ts +263 -0
- package/src/compliance/gap-report.ts +94 -0
- package/src/compliance/html.ts +295 -0
- package/src/compliance/impact.ts +677 -0
- package/src/compliance/index.ts +56 -0
- package/src/compliance/markdown.ts +135 -0
- package/src/compliance/reverse-index.ts +33 -0
- package/src/compliance/types.ts +120 -0
- package/src/compliance/views.ts +46 -0
- package/src/compliance-matrix/__tests__/build.test.ts +200 -0
- package/src/compliance-matrix/__tests__/example.test.ts +57 -0
- package/src/compliance-matrix/build.ts +0 -0
- package/src/compliance-matrix/index.ts +11 -0
- package/src/compliance-matrix/types.ts +102 -0
- package/src/confidence/__tests__/score.test.ts +254 -0
- package/src/confidence/index.ts +21 -0
- package/src/confidence/score.ts +243 -0
- package/src/confidence/types.ts +96 -0
- package/src/edge-path.ts +44 -0
- package/src/element-envelope.ts +76 -0
- package/src/factor/__tests__/validate.test.ts +98 -0
- package/src/factor/index.ts +8 -0
- package/src/factor/types.ts +41 -0
- package/src/factor/validate.ts +74 -0
- package/src/fgca/__tests__/chain-table.test.ts +172 -0
- package/src/fgca/__tests__/layout.test.ts +179 -0
- package/src/fgca/__tests__/parse-canonical.test.ts +248 -0
- package/src/fgca/__tests__/preview-layout.test.ts +124 -0
- package/src/fgca/__tests__/validate.test.ts +142 -0
- package/src/fgca/chain-table.ts +225 -0
- package/src/fgca/index.ts +45 -0
- package/src/fgca/layout.ts +204 -0
- package/src/fgca/nodeTypes.ts +11 -0
- package/src/fgca/nodes/FGCAActivityNode.tsx +65 -0
- package/src/fgca/nodes/FGCAChangeNode.tsx +64 -0
- package/src/fgca/nodes/FGCAFactorNode.tsx +64 -0
- package/src/fgca/nodes/FGCAGoalNode.tsx +72 -0
- package/src/fgca/parse-canonical.ts +400 -0
- package/src/fgca/preview-layout.ts +217 -0
- package/src/fgca/types.ts +50 -0
- package/src/fgca/validate.ts +126 -0
- package/src/geometry.ts +9 -0
- package/src/goals/__tests__/layout.test.ts +175 -0
- package/src/goals/__tests__/mutations.test.ts +111 -0
- package/src/goals/__tests__/parse-canonical.test.ts +145 -0
- package/src/goals/__tests__/validate.test.ts +202 -0
- package/src/goals/index.ts +21 -0
- package/src/goals/layout.ts +172 -0
- package/src/goals/mutations.ts +123 -0
- package/src/goals/parse-canonical.ts +286 -0
- package/src/goals/types.ts +85 -0
- package/src/goals/validate.ts +136 -0
- package/src/index.ts +23 -0
- package/src/process-blueprint/__tests__/compliance-lane.test.ts +320 -0
- package/src/process-blueprint/__tests__/layout.test.ts +195 -0
- package/src/process-blueprint/__tests__/validate.test.ts +310 -0
- package/src/process-blueprint/index.ts +31 -0
- package/src/process-blueprint/layout.ts +531 -0
- package/src/process-blueprint/types.ts +242 -0
- package/src/process-blueprint/validate.ts +181 -0
- package/src/process-map/__tests__/validate.test.ts +223 -0
- package/src/process-map/index.ts +10 -0
- package/src/process-map/types.ts +36 -0
- package/src/process-map/validate.ts +135 -0
- package/src/products/__tests__/validate.test.ts +239 -0
- package/src/products/index.ts +9 -0
- package/src/products/types.ts +31 -0
- package/src/products/validate.ts +112 -0
- package/src/repo-validate/__tests__/validate-repo.test.ts +149 -0
- package/src/repo-validate/index.ts +2 -0
- package/src/repo-validate/types.ts +50 -0
- package/src/repo-validate/validate-repo.ts +196 -0
- package/src/requirement/__tests__/example.test.ts +24 -0
- package/src/requirement/__tests__/validate.test.ts +96 -0
- package/src/requirement/index.ts +4 -0
- package/src/requirement/types.ts +35 -0
- package/src/requirement/validate.ts +92 -0
- package/src/scenarios/__tests__/validate.test.ts +209 -0
- package/src/scenarios/index.ts +15 -0
- package/src/scenarios/types.ts +37 -0
- package/src/scenarios/validate.ts +122 -0
- package/src/schema-version.ts +16 -0
- package/src/scope.ts +46 -0
- package/src/stakeholder/__tests__/validate.test.ts +101 -0
- package/src/stakeholder/index.ts +3 -0
- package/src/stakeholder/types.ts +33 -0
- package/src/stakeholder/validate.ts +63 -0
- package/src/target-state/__tests__/validate.test.ts +74 -0
- package/src/target-state/index.ts +2 -0
- package/src/target-state/types.ts +28 -0
- package/src/target-state/validate.ts +67 -0
- package/src/theme/index.ts +4 -0
- package/src/theme/themes.ts +237 -0
- package/src/theme/tokens.ts +133 -0
- package/src/typed-id.ts +56 -0
- package/src/validation-types.ts +36 -0
- package/src/webview/__tests__/entry-notations.test.ts +77 -0
- package/src/webview/__tests__/entry.test.ts +64 -0
- package/src/webview/__tests__/render-goals.test.ts +72 -0
- package/src/webview/entry.ts +292 -0
- package/src/webview/render-activities.ts +156 -0
- package/src/webview/render-activity-card.ts +234 -0
- package/src/webview/render-applications.ts +123 -0
- package/src/webview/render-blocks.ts +91 -0
- package/src/webview/render-capability-map.ts +98 -0
- package/src/webview/render-fgca.ts +122 -0
- package/src/webview/render-goals.ts +110 -0
- package/src/webview/render-process-blueprint.ts +207 -0
- package/src/webview/render-process-map.ts +93 -0
- package/src/webview/render-products.ts +91 -0
- package/src/webview/render-scenarios.ts +90 -0
- package/src/webview/render-util.ts +34 -0
- package/src/webview/styles.css +323 -0
- package/src/yaml-normalize.ts +56 -0
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
// ASSERTION validator — methodology notations/elements/16-assertion.md §5.
|
|
2
|
+
//
|
|
3
|
+
// Implements ASSERT-001..008. The shared HDR-/LIFECYCLE- rules and the
|
|
4
|
+
// cross-cutting ASSERT-DEAD-LINK-001 are owned elsewhere (CONTRACT.md §8) and
|
|
5
|
+
// are out of scope for this single-artefact validator.
|
|
6
|
+
//
|
|
7
|
+
// Resolution rules (ASSERT-002/003/004/005) that need artefact *existence*
|
|
8
|
+
// run only when a `CanonCatalog` is supplied; the TYPE checks they also carry
|
|
9
|
+
// are derivable from the id prefix and run either way. ASSERT-008 (staleness)
|
|
10
|
+
// runs only when `today` is supplied, keeping the validator clock-free.
|
|
11
|
+
import { typeOfId, isCanonicalIdOfType } from '../typed-id.js';
|
|
12
|
+
import { ASSERTION_STATUSES, ASSERTION_SUBJECT_TYPES } from './types.js';
|
|
13
|
+
const SUBJECT_TYPES = ASSERTION_SUBJECT_TYPES;
|
|
14
|
+
export function validateAssertion(input, options = {}) {
|
|
15
|
+
const errors = [];
|
|
16
|
+
const warnings = [];
|
|
17
|
+
const { catalog, today } = options;
|
|
18
|
+
if (input === null || typeof input !== 'object' || Array.isArray(input)) {
|
|
19
|
+
errors.push({ code: 'ASSERT-001', message: 'Assertion must be a YAML mapping.' });
|
|
20
|
+
return { valid: false, errors, warnings };
|
|
21
|
+
}
|
|
22
|
+
const a = input;
|
|
23
|
+
// ── ASSERT-001 — id grammar + plain required fields ──────────────────────
|
|
24
|
+
if (!isCanonicalIdOfType(a.id, 'ASSERTION')) {
|
|
25
|
+
errors.push({ code: 'ASSERT-001', message: `id "${String(a.id)}" must match ASSERTION-[<middle>-]<INTEGER>.`, path: 'id' });
|
|
26
|
+
}
|
|
27
|
+
if (a.notation !== 'assertion') {
|
|
28
|
+
errors.push({ code: 'ASSERT-001', message: 'notation must be the fixed value "assertion".', path: 'notation' });
|
|
29
|
+
}
|
|
30
|
+
if (a.zone !== 'canon') {
|
|
31
|
+
errors.push({ code: 'ASSERT-001', message: 'zone is required and must be "canon".', path: 'zone' });
|
|
32
|
+
}
|
|
33
|
+
for (const f of ['admitted_at', 'admitted_by', 'valid_from']) {
|
|
34
|
+
if (typeof a[f] !== 'string' || a[f].trim() === '') {
|
|
35
|
+
errors.push({ code: 'ASSERT-001', message: `${f} is required.`, path: f });
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
if (a.gate_checks === null || typeof a.gate_checks !== 'object') {
|
|
39
|
+
errors.push({ code: 'ASSERT-001', message: 'gate_checks is required and must be a mapping.', path: 'gate_checks' });
|
|
40
|
+
}
|
|
41
|
+
if (!('valid_to' in a) || !(typeof a.valid_to === 'string' || a.valid_to === null)) {
|
|
42
|
+
errors.push({ code: 'ASSERT-001', message: 'valid_to is required (an ISO date string or null).', path: 'valid_to' });
|
|
43
|
+
}
|
|
44
|
+
// ── ASSERT-002 — about → REQUIREMENT ─────────────────────────────────────
|
|
45
|
+
const about = a.about;
|
|
46
|
+
if (typeof about !== 'string' || about.trim() === '') {
|
|
47
|
+
errors.push({ code: 'ASSERT-002', message: 'about is required and must be a typed REQUIREMENT id.', path: 'about' });
|
|
48
|
+
}
|
|
49
|
+
else if (catalog) {
|
|
50
|
+
const t = catalog.typeOf(about);
|
|
51
|
+
if (t === undefined) {
|
|
52
|
+
errors.push({ code: 'ASSERT-002', message: `about "${about}" does not resolve to an admitted artefact.`, path: 'about' });
|
|
53
|
+
}
|
|
54
|
+
else if (t !== 'REQUIREMENT') {
|
|
55
|
+
errors.push({ code: 'ASSERT-002', message: `about "${about}" resolves to a ${t}, not a REQUIREMENT.`, path: 'about' });
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
else if (typeOfId(about) !== 'REQUIREMENT') {
|
|
59
|
+
errors.push({ code: 'ASSERT-002', message: `about "${about}" must be a REQUIREMENT typed id.`, path: 'about' });
|
|
60
|
+
}
|
|
61
|
+
// ── ASSERT-003 — subject ∈ {PRODUCT, PROCESS, CAPABILITY} ────────────────
|
|
62
|
+
const subject = a.subject;
|
|
63
|
+
if (typeof subject !== 'string' || subject.trim() === '') {
|
|
64
|
+
errors.push({ code: 'ASSERT-003', message: 'subject is required and must be a typed PRODUCT/PROCESS/CAPABILITY id.', path: 'subject' });
|
|
65
|
+
}
|
|
66
|
+
else if (catalog) {
|
|
67
|
+
const t = catalog.typeOf(subject);
|
|
68
|
+
if (t === undefined) {
|
|
69
|
+
errors.push({ code: 'ASSERT-003', message: `subject "${subject}" does not resolve to an admitted artefact.`, path: 'subject' });
|
|
70
|
+
}
|
|
71
|
+
else if (!SUBJECT_TYPES.includes(t)) {
|
|
72
|
+
errors.push({ code: 'ASSERT-003', message: `subject "${subject}" resolves to a ${t}; must be PRODUCT, PROCESS or CAPABILITY.`, path: 'subject' });
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
else {
|
|
76
|
+
const t = typeOfId(subject);
|
|
77
|
+
if (!t || !SUBJECT_TYPES.includes(t)) {
|
|
78
|
+
errors.push({ code: 'ASSERT-003', message: `subject "${subject}" TYPE must be PRODUCT, PROCESS or CAPABILITY.`, path: 'subject' });
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
// ── ASSERT-004 — realised_via resolves ───────────────────────────────────
|
|
82
|
+
if (a.realised_via !== undefined) {
|
|
83
|
+
if (!Array.isArray(a.realised_via)) {
|
|
84
|
+
errors.push({ code: 'ASSERT-001', message: 'realised_via must be a list of typed IDs.', path: 'realised_via' });
|
|
85
|
+
}
|
|
86
|
+
else {
|
|
87
|
+
a.realised_via.forEach((ref, i) => {
|
|
88
|
+
if (!typeOfId(ref)) {
|
|
89
|
+
errors.push({ code: 'ASSERT-004', message: `realised_via[${i}] "${String(ref)}" is not a resolvable typed ID.`, path: `realised_via[${i}]` });
|
|
90
|
+
}
|
|
91
|
+
else if (catalog && catalog.typeOf(ref) === undefined) {
|
|
92
|
+
errors.push({ code: 'ASSERT-004', message: `realised_via[${i}] "${String(ref)}" does not resolve to an admitted element.`, path: `realised_via[${i}]` });
|
|
93
|
+
}
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
// ── ASSERT-005 — canonical_ref evidence resolves ─────────────────────────
|
|
98
|
+
if (a.evidence !== undefined) {
|
|
99
|
+
if (!Array.isArray(a.evidence)) {
|
|
100
|
+
errors.push({ code: 'ASSERT-001', message: 'evidence must be a list.', path: 'evidence' });
|
|
101
|
+
}
|
|
102
|
+
else {
|
|
103
|
+
a.evidence.forEach((e, i) => {
|
|
104
|
+
if (e === null || typeof e !== 'object')
|
|
105
|
+
return;
|
|
106
|
+
const entry = e;
|
|
107
|
+
if (entry.kind !== 'canonical_ref')
|
|
108
|
+
return;
|
|
109
|
+
const ref = entry.ref;
|
|
110
|
+
if (!typeOfId(ref)) {
|
|
111
|
+
errors.push({ code: 'ASSERT-005', message: `evidence[${i}] canonical_ref "${String(ref)}" is not a resolvable typed ID.`, path: `evidence[${i}].ref` });
|
|
112
|
+
}
|
|
113
|
+
else if (catalog && catalog.typeOf(ref) === undefined) {
|
|
114
|
+
errors.push({ code: 'ASSERT-005', message: `evidence[${i}] canonical_ref "${String(ref)}" does not resolve.`, path: `evidence[${i}].ref` });
|
|
115
|
+
}
|
|
116
|
+
});
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
// ── ASSERT-006 / ASSERT-001 — status ─────────────────────────────────────
|
|
120
|
+
const status = a.status;
|
|
121
|
+
if (status === undefined || status === null) {
|
|
122
|
+
errors.push({ code: 'ASSERT-001', message: 'status is required.', path: 'status' });
|
|
123
|
+
}
|
|
124
|
+
else if (!ASSERTION_STATUSES.includes(status)) {
|
|
125
|
+
errors.push({ code: 'ASSERT-006', message: `status "${String(status)}" must be one of ${ASSERTION_STATUSES.join(', ')}.`, path: 'status' });
|
|
126
|
+
}
|
|
127
|
+
// ── ASSERT-007 (warning) — positive status with no evidence ──────────────
|
|
128
|
+
const evidenceEmpty = !Array.isArray(a.evidence) || a.evidence.length === 0;
|
|
129
|
+
if (evidenceEmpty && (status === 'compliant' || status === 'partial')) {
|
|
130
|
+
warnings.push({ code: 'ASSERT-007', message: `status "${status}" has no evidence — a positive status without evidence is undefended.`, path: 'evidence' });
|
|
131
|
+
}
|
|
132
|
+
// ── ASSERT-008 (warning) — stale review (only when `today` is known) ──────
|
|
133
|
+
if (today && typeof a.next_review_at === 'string' && a.next_review_at < today) {
|
|
134
|
+
warnings.push({ code: 'ASSERT-008', message: `next_review_at ${a.next_review_at} is in the past — the assertion is stale and due for re-review.`, path: 'next_review_at' });
|
|
135
|
+
}
|
|
136
|
+
return { valid: errors.length === 0, errors, warnings };
|
|
137
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
import { describe, it, expect } from 'vitest';
|
|
2
|
+
import { layoutNestedBlocks, iterateBlocks } from '../layout.js';
|
|
3
|
+
function findById(layout, id) {
|
|
4
|
+
for (const b of iterateBlocks(layout)) {
|
|
5
|
+
if (b.id === id)
|
|
6
|
+
return b;
|
|
7
|
+
}
|
|
8
|
+
return undefined;
|
|
9
|
+
}
|
|
10
|
+
const TWO_TOP_LEVEL = {
|
|
11
|
+
notation: 'blocks',
|
|
12
|
+
spec_version: '0.1',
|
|
13
|
+
nested_blocks: {
|
|
14
|
+
id: 'BLOCKS-ARCH-1',
|
|
15
|
+
name: 'Software architecture',
|
|
16
|
+
blocks: [
|
|
17
|
+
{
|
|
18
|
+
id: 'APPLICATION_LAYER',
|
|
19
|
+
name: 'Application Layer',
|
|
20
|
+
children: [
|
|
21
|
+
{
|
|
22
|
+
id: 'FRONTEND',
|
|
23
|
+
name: 'Frontend',
|
|
24
|
+
children: [
|
|
25
|
+
{ id: 'REACT_APP', name: 'React App' },
|
|
26
|
+
{ id: 'REDUX_STORE', name: 'Redux Store' },
|
|
27
|
+
],
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
id: 'BACKEND',
|
|
31
|
+
name: 'Backend',
|
|
32
|
+
children: [
|
|
33
|
+
{ id: 'REST_API', name: 'REST API' },
|
|
34
|
+
{ id: 'BUSINESS_LOGIC', name: 'Business Logic' },
|
|
35
|
+
],
|
|
36
|
+
},
|
|
37
|
+
],
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
id: 'DATA_LAYER',
|
|
41
|
+
name: 'Data Layer',
|
|
42
|
+
children: [
|
|
43
|
+
{ id: 'POSTGRESQL', name: 'PostgreSQL' },
|
|
44
|
+
{ id: 'REDIS_CACHE', name: 'Redis Cache' },
|
|
45
|
+
],
|
|
46
|
+
},
|
|
47
|
+
],
|
|
48
|
+
},
|
|
49
|
+
};
|
|
50
|
+
describe('layoutNestedBlocks', () => {
|
|
51
|
+
it('lays out top-level blocks vertically starting at y=0', () => {
|
|
52
|
+
const layout = layoutNestedBlocks(TWO_TOP_LEVEL);
|
|
53
|
+
expect(layout.blocks).toHaveLength(2);
|
|
54
|
+
expect(layout.blocks[0].y).toBe(0);
|
|
55
|
+
expect(layout.blocks[1].y).toBeGreaterThan(layout.blocks[0].y + layout.blocks[0].height);
|
|
56
|
+
});
|
|
57
|
+
it('assigns depth=1 to top-level blocks and increases for each nesting level', () => {
|
|
58
|
+
const layout = layoutNestedBlocks(TWO_TOP_LEVEL);
|
|
59
|
+
const app = findById(layout, 'APPLICATION_LAYER');
|
|
60
|
+
const frontend = findById(layout, 'FRONTEND');
|
|
61
|
+
const react = findById(layout, 'REACT_APP');
|
|
62
|
+
expect(app.depth).toBe(1);
|
|
63
|
+
expect(frontend.depth).toBe(2);
|
|
64
|
+
expect(react.depth).toBe(3);
|
|
65
|
+
});
|
|
66
|
+
it('records max depth on the layout', () => {
|
|
67
|
+
const layout = layoutNestedBlocks(TWO_TOP_LEVEL);
|
|
68
|
+
expect(layout.maxDepth).toBe(3);
|
|
69
|
+
});
|
|
70
|
+
it('places every child strictly inside its parent (containment property)', () => {
|
|
71
|
+
const layout = layoutNestedBlocks(TWO_TOP_LEVEL);
|
|
72
|
+
function checkContainment(b) {
|
|
73
|
+
for (const c of b.children) {
|
|
74
|
+
expect(c.x).toBeGreaterThanOrEqual(b.x);
|
|
75
|
+
expect(c.y).toBeGreaterThanOrEqual(b.y + b.headerHeight);
|
|
76
|
+
expect(c.x + c.width).toBeLessThanOrEqual(b.x + b.width);
|
|
77
|
+
expect(c.y + c.height).toBeLessThanOrEqual(b.y + b.height);
|
|
78
|
+
checkContainment(c);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
for (const top of layout.blocks)
|
|
82
|
+
checkContainment(top);
|
|
83
|
+
});
|
|
84
|
+
it('siblings do not overlap', () => {
|
|
85
|
+
const layout = layoutNestedBlocks(TWO_TOP_LEVEL);
|
|
86
|
+
function checkSiblings(b) {
|
|
87
|
+
for (let i = 0; i < b.children.length; i++) {
|
|
88
|
+
for (let j = i + 1; j < b.children.length; j++) {
|
|
89
|
+
const a = b.children[i];
|
|
90
|
+
const c = b.children[j];
|
|
91
|
+
const disjointX = a.x + a.width <= c.x || c.x + c.width <= a.x;
|
|
92
|
+
const disjointY = a.y + a.height <= c.y || c.y + c.height <= a.y;
|
|
93
|
+
expect(disjointX || disjointY).toBe(true);
|
|
94
|
+
}
|
|
95
|
+
checkSiblings(b.children[i]);
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
for (const top of layout.blocks)
|
|
99
|
+
checkSiblings(top);
|
|
100
|
+
});
|
|
101
|
+
it('a leaf block uses the configured leaf dimensions', () => {
|
|
102
|
+
const layout = layoutNestedBlocks({
|
|
103
|
+
notation: 'blocks',
|
|
104
|
+
nested_blocks: {
|
|
105
|
+
id: 'BLOCKS-LEAF-1',
|
|
106
|
+
name: 'Leaf only',
|
|
107
|
+
blocks: [{ id: 'A', name: 'A' }],
|
|
108
|
+
},
|
|
109
|
+
});
|
|
110
|
+
const a = layout.blocks[0];
|
|
111
|
+
expect(a.width).toBe(160);
|
|
112
|
+
expect(a.height).toBe(60);
|
|
113
|
+
});
|
|
114
|
+
it('honours custom layout options', () => {
|
|
115
|
+
const layout = layoutNestedBlocks({
|
|
116
|
+
notation: 'blocks',
|
|
117
|
+
nested_blocks: {
|
|
118
|
+
id: 'BLOCKS-LEAF-1',
|
|
119
|
+
name: 'Leaf only',
|
|
120
|
+
blocks: [{ id: 'A', name: 'A' }],
|
|
121
|
+
},
|
|
122
|
+
}, { leafWidth: 200, leafHeight: 80 });
|
|
123
|
+
expect(layout.blocks[0].width).toBe(200);
|
|
124
|
+
expect(layout.blocks[0].height).toBe(80);
|
|
125
|
+
});
|
|
126
|
+
it('iterateBlocks visits every block once in pre-order', () => {
|
|
127
|
+
const layout = layoutNestedBlocks(TWO_TOP_LEVEL);
|
|
128
|
+
const ids = Array.from(iterateBlocks(layout)).map((b) => b.id);
|
|
129
|
+
expect(ids).toEqual([
|
|
130
|
+
'APPLICATION_LAYER',
|
|
131
|
+
'FRONTEND',
|
|
132
|
+
'REACT_APP',
|
|
133
|
+
'REDUX_STORE',
|
|
134
|
+
'BACKEND',
|
|
135
|
+
'REST_API',
|
|
136
|
+
'BUSINESS_LOGIC',
|
|
137
|
+
'DATA_LAYER',
|
|
138
|
+
'POSTGRESQL',
|
|
139
|
+
'REDIS_CACHE',
|
|
140
|
+
]);
|
|
141
|
+
});
|
|
142
|
+
it('handles an empty top-level array gracefully (returns zero-size bounds)', () => {
|
|
143
|
+
const layout = layoutNestedBlocks({
|
|
144
|
+
notation: 'blocks',
|
|
145
|
+
// Schema-wise this is invalid (BL-004), but the layout function still
|
|
146
|
+
// needs to be defensive — validation runs separately.
|
|
147
|
+
nested_blocks: { id: 'X', name: 'X', blocks: [] },
|
|
148
|
+
});
|
|
149
|
+
expect(layout.blocks).toHaveLength(0);
|
|
150
|
+
expect(layout.bounds.width).toBe(0);
|
|
151
|
+
expect(layout.bounds.height).toBe(0);
|
|
152
|
+
});
|
|
153
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
import { describe, it, expect } from 'vitest';
|
|
2
|
+
import * as fs from 'node:fs';
|
|
3
|
+
import * as path from 'node:path';
|
|
4
|
+
import yaml from 'js-yaml';
|
|
5
|
+
import { validateNestedBlocks } from '../validate.js';
|
|
6
|
+
const EXAMPLES_DIR = path.resolve(process.cwd(), '..', '..', 'tests', 'fixtures', 'notation-corpus', 'blocks');
|
|
7
|
+
const VALID_DOC = {
|
|
8
|
+
notation: 'blocks',
|
|
9
|
+
spec_version: '0.1',
|
|
10
|
+
nested_blocks: {
|
|
11
|
+
id: 'BLOCKS-ARCH-1',
|
|
12
|
+
name: 'Software architecture',
|
|
13
|
+
blocks: [
|
|
14
|
+
{
|
|
15
|
+
id: 'APPLICATION_LAYER',
|
|
16
|
+
name: 'Application Layer',
|
|
17
|
+
children: [
|
|
18
|
+
{ id: 'FRONTEND', name: 'Frontend' },
|
|
19
|
+
{ id: 'BACKEND', name: 'Backend' },
|
|
20
|
+
],
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
id: 'DATA_LAYER',
|
|
24
|
+
name: 'Data Layer',
|
|
25
|
+
children: [
|
|
26
|
+
{ id: 'POSTGRESQL', name: 'PostgreSQL' },
|
|
27
|
+
{ id: 'REDIS_CACHE', name: 'Redis Cache' },
|
|
28
|
+
],
|
|
29
|
+
},
|
|
30
|
+
],
|
|
31
|
+
},
|
|
32
|
+
};
|
|
33
|
+
describe('validateNestedBlocks', () => {
|
|
34
|
+
it('passes on a valid document', () => {
|
|
35
|
+
const r = validateNestedBlocks(VALID_DOC);
|
|
36
|
+
expect(r.valid).toBe(true);
|
|
37
|
+
expect(r.errors).toHaveLength(0);
|
|
38
|
+
});
|
|
39
|
+
it('BL-001: rejects non-object input', () => {
|
|
40
|
+
expect(validateNestedBlocks(null).valid).toBe(false);
|
|
41
|
+
expect(validateNestedBlocks(null).errors[0].code).toBe('BL-001');
|
|
42
|
+
expect(validateNestedBlocks('string').errors[0].code).toBe('BL-001');
|
|
43
|
+
});
|
|
44
|
+
it('BL-001: rejects missing nested_blocks root key', () => {
|
|
45
|
+
const r = validateNestedBlocks({ notation: 'blocks' });
|
|
46
|
+
expect(r.errors.some((e) => e.code === 'BL-001')).toBe(true);
|
|
47
|
+
});
|
|
48
|
+
it('BL-001: rejects wrong notation value', () => {
|
|
49
|
+
const r = validateNestedBlocks({ ...VALID_DOC, notation: 'goals' });
|
|
50
|
+
expect(r.errors.some((e) => e.code === 'BL-001')).toBe(true);
|
|
51
|
+
});
|
|
52
|
+
it('BL-001: tolerates a missing notation field (header check is contract-level)', () => {
|
|
53
|
+
const { notation: _, ...rest } = VALID_DOC;
|
|
54
|
+
const r = validateNestedBlocks(rest);
|
|
55
|
+
expect(r.errors.some((e) => e.code === 'BL-001')).toBe(false);
|
|
56
|
+
});
|
|
57
|
+
it('BL-002: rejects missing id', () => {
|
|
58
|
+
const r = validateNestedBlocks({
|
|
59
|
+
...VALID_DOC,
|
|
60
|
+
nested_blocks: { ...VALID_DOC.nested_blocks, id: '' },
|
|
61
|
+
});
|
|
62
|
+
expect(r.errors.some((e) => e.code === 'BL-002')).toBe(true);
|
|
63
|
+
});
|
|
64
|
+
it('BL-002: rejects id that does not match BLOCKS grammar', () => {
|
|
65
|
+
const r = validateNestedBlocks({
|
|
66
|
+
...VALID_DOC,
|
|
67
|
+
nested_blocks: { ...VALID_DOC.nested_blocks, id: 'BLK-1' },
|
|
68
|
+
});
|
|
69
|
+
expect(r.errors.some((e) => e.code === 'BL-002')).toBe(true);
|
|
70
|
+
});
|
|
71
|
+
it('BL-003: rejects missing name', () => {
|
|
72
|
+
const r = validateNestedBlocks({
|
|
73
|
+
...VALID_DOC,
|
|
74
|
+
nested_blocks: { ...VALID_DOC.nested_blocks, name: '' },
|
|
75
|
+
});
|
|
76
|
+
expect(r.errors.some((e) => e.code === 'BL-003')).toBe(true);
|
|
77
|
+
});
|
|
78
|
+
it('BL-004: rejects missing blocks array', () => {
|
|
79
|
+
const { blocks: _, ...rest } = VALID_DOC.nested_blocks;
|
|
80
|
+
const r = validateNestedBlocks({ ...VALID_DOC, nested_blocks: rest });
|
|
81
|
+
expect(r.errors.some((e) => e.code === 'BL-004')).toBe(true);
|
|
82
|
+
});
|
|
83
|
+
it('BL-004: rejects empty blocks array', () => {
|
|
84
|
+
const r = validateNestedBlocks({
|
|
85
|
+
...VALID_DOC,
|
|
86
|
+
nested_blocks: { ...VALID_DOC.nested_blocks, blocks: [] },
|
|
87
|
+
});
|
|
88
|
+
expect(r.errors.some((e) => e.code === 'BL-004')).toBe(true);
|
|
89
|
+
});
|
|
90
|
+
it('BL-005: rejects block missing id', () => {
|
|
91
|
+
const r = validateNestedBlocks({
|
|
92
|
+
...VALID_DOC,
|
|
93
|
+
nested_blocks: {
|
|
94
|
+
...VALID_DOC.nested_blocks,
|
|
95
|
+
blocks: [{ name: 'Anonymous' }],
|
|
96
|
+
},
|
|
97
|
+
});
|
|
98
|
+
expect(r.errors.some((e) => e.code === 'BL-005' && /id/.test(e.message))).toBe(true);
|
|
99
|
+
});
|
|
100
|
+
it('BL-005: rejects block missing name', () => {
|
|
101
|
+
const r = validateNestedBlocks({
|
|
102
|
+
...VALID_DOC,
|
|
103
|
+
nested_blocks: {
|
|
104
|
+
...VALID_DOC.nested_blocks,
|
|
105
|
+
blocks: [{ id: 'X', name: '' }],
|
|
106
|
+
},
|
|
107
|
+
});
|
|
108
|
+
expect(r.errors.some((e) => e.code === 'BL-005' && /name/.test(e.message))).toBe(true);
|
|
109
|
+
});
|
|
110
|
+
it('BL-005: rejects an id with whitespace (not a valid free label)', () => {
|
|
111
|
+
const r = validateNestedBlocks({
|
|
112
|
+
...VALID_DOC,
|
|
113
|
+
nested_blocks: {
|
|
114
|
+
...VALID_DOC.nested_blocks,
|
|
115
|
+
blocks: [{ id: 'bad id', name: 'X' }],
|
|
116
|
+
},
|
|
117
|
+
});
|
|
118
|
+
expect(r.errors.some((e) => e.code === 'BL-005' && /whitespace/.test(e.message))).toBe(true);
|
|
119
|
+
});
|
|
120
|
+
it('BL-006: rejects a canonical-shaped id whose TYPE is not registered', () => {
|
|
121
|
+
const r = validateNestedBlocks({
|
|
122
|
+
...VALID_DOC,
|
|
123
|
+
nested_blocks: {
|
|
124
|
+
...VALID_DOC.nested_blocks,
|
|
125
|
+
blocks: [{ id: 'XYZ-SOMETHING-1', name: 'X' }],
|
|
126
|
+
},
|
|
127
|
+
});
|
|
128
|
+
expect(r.errors.some((e) => e.code === 'BL-006')).toBe(true);
|
|
129
|
+
});
|
|
130
|
+
it('BL-006: accepts canonical ids with registered TYPE (APPLICATION-OMS-1)', () => {
|
|
131
|
+
const r = validateNestedBlocks({
|
|
132
|
+
...VALID_DOC,
|
|
133
|
+
nested_blocks: {
|
|
134
|
+
...VALID_DOC.nested_blocks,
|
|
135
|
+
blocks: [{ id: 'APPLICATION-OMS-1', name: 'OMS' }],
|
|
136
|
+
},
|
|
137
|
+
});
|
|
138
|
+
expect(r.errors.some((e) => e.code === 'BL-006')).toBe(false);
|
|
139
|
+
});
|
|
140
|
+
it('BL-006: accepts the CAPABILITY V/H exception (CAPABILITY-V1.2)', () => {
|
|
141
|
+
const r = validateNestedBlocks({
|
|
142
|
+
...VALID_DOC,
|
|
143
|
+
nested_blocks: {
|
|
144
|
+
...VALID_DOC.nested_blocks,
|
|
145
|
+
blocks: [{ id: 'CAPABILITY-V1.2', name: 'Order intake' }],
|
|
146
|
+
},
|
|
147
|
+
});
|
|
148
|
+
expect(r.errors.some((e) => e.code === 'BL-006')).toBe(false);
|
|
149
|
+
});
|
|
150
|
+
it('BL-006: accepts free-form local labels (APPLICATION_LAYER, frontend, my-thing)', () => {
|
|
151
|
+
const r = validateNestedBlocks({
|
|
152
|
+
...VALID_DOC,
|
|
153
|
+
nested_blocks: {
|
|
154
|
+
...VALID_DOC.nested_blocks,
|
|
155
|
+
blocks: [
|
|
156
|
+
{ id: 'APPLICATION_LAYER', name: 'AL' },
|
|
157
|
+
{ id: 'my-thing', name: 'MT' },
|
|
158
|
+
{ id: 'FRONTEND', name: 'FE' },
|
|
159
|
+
],
|
|
160
|
+
},
|
|
161
|
+
});
|
|
162
|
+
expect(r.errors.some((e) => e.code === 'BL-006')).toBe(false);
|
|
163
|
+
});
|
|
164
|
+
it('BL-007: rejects duplicate ids anywhere in the tree', () => {
|
|
165
|
+
const r = validateNestedBlocks({
|
|
166
|
+
...VALID_DOC,
|
|
167
|
+
nested_blocks: {
|
|
168
|
+
...VALID_DOC.nested_blocks,
|
|
169
|
+
blocks: [
|
|
170
|
+
{
|
|
171
|
+
id: 'A',
|
|
172
|
+
name: 'A',
|
|
173
|
+
children: [{ id: 'A', name: 'A again' }],
|
|
174
|
+
},
|
|
175
|
+
],
|
|
176
|
+
},
|
|
177
|
+
});
|
|
178
|
+
expect(r.errors.some((e) => e.code === 'BL-007' && /Duplicate/.test(e.message))).toBe(true);
|
|
179
|
+
});
|
|
180
|
+
it('BL-008: warns when nesting exceeds depth 5', () => {
|
|
181
|
+
// 6-deep chain: blocks[0] (depth 1) → c → c → c → c → c (depth 6)
|
|
182
|
+
let inner = { id: 'L6', name: 'L6' };
|
|
183
|
+
for (const id of ['L5', 'L4', 'L3', 'L2', 'L1']) {
|
|
184
|
+
inner = { id, name: id, children: [inner] };
|
|
185
|
+
}
|
|
186
|
+
const r = validateNestedBlocks({
|
|
187
|
+
...VALID_DOC,
|
|
188
|
+
nested_blocks: { ...VALID_DOC.nested_blocks, blocks: [inner] },
|
|
189
|
+
});
|
|
190
|
+
expect(r.warnings.some((w) => w.code === 'BL-008')).toBe(true);
|
|
191
|
+
expect(r.valid).toBe(true);
|
|
192
|
+
});
|
|
193
|
+
it('BL-008: does not warn at exactly depth 5', () => {
|
|
194
|
+
let inner = { id: 'L5', name: 'L5' };
|
|
195
|
+
for (const id of ['L4', 'L3', 'L2', 'L1']) {
|
|
196
|
+
inner = { id, name: id, children: [inner] };
|
|
197
|
+
}
|
|
198
|
+
const r = validateNestedBlocks({
|
|
199
|
+
...VALID_DOC,
|
|
200
|
+
nested_blocks: { ...VALID_DOC.nested_blocks, blocks: [inner] },
|
|
201
|
+
});
|
|
202
|
+
expect(r.warnings.some((w) => w.code === 'BL-008')).toBe(false);
|
|
203
|
+
});
|
|
204
|
+
it('BL-009: warns on an empty children array', () => {
|
|
205
|
+
const r = validateNestedBlocks({
|
|
206
|
+
...VALID_DOC,
|
|
207
|
+
nested_blocks: {
|
|
208
|
+
...VALID_DOC.nested_blocks,
|
|
209
|
+
blocks: [{ id: 'A', name: 'A', children: [] }],
|
|
210
|
+
},
|
|
211
|
+
});
|
|
212
|
+
expect(r.warnings.some((w) => w.code === 'BL-009')).toBe(true);
|
|
213
|
+
expect(r.valid).toBe(true);
|
|
214
|
+
});
|
|
215
|
+
it('happy path: surfaces no warnings on a clean document', () => {
|
|
216
|
+
const r = validateNestedBlocks(VALID_DOC);
|
|
217
|
+
expect(r.valid).toBe(true);
|
|
218
|
+
expect(r.warnings).toHaveLength(0);
|
|
219
|
+
});
|
|
220
|
+
});
|
|
221
|
+
describe('blocks examples (regression)', () => {
|
|
222
|
+
const files = fs.existsSync(EXAMPLES_DIR)
|
|
223
|
+
? fs.readdirSync(EXAMPLES_DIR).filter((f) => f.endsWith('.yaml'))
|
|
224
|
+
: [];
|
|
225
|
+
expect(files.length).toBeGreaterThan(0);
|
|
226
|
+
for (const file of files) {
|
|
227
|
+
it(`validates tests/fixtures/notation-corpus/blocks/${file}`, () => {
|
|
228
|
+
const text = fs.readFileSync(path.join(EXAMPLES_DIR, file), 'utf8');
|
|
229
|
+
const parsed = yaml.load(text);
|
|
230
|
+
const r = validateNestedBlocks(parsed);
|
|
231
|
+
expect(r.errors).toEqual([]);
|
|
232
|
+
expect(r.valid).toBe(true);
|
|
233
|
+
});
|
|
234
|
+
}
|
|
235
|
+
});
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export type { Block, NestedBlocksHeader, BlocksFile, BlocksLayoutOptions, LaidOutBlock, BlocksLayout, } from './types.js';
|
|
2
|
+
export { validateNestedBlocks, isWellFormedBlock } from './validate.js';
|
|
3
|
+
export type { ValidationError as BlocksValidationError, ValidationWarning as BlocksValidationWarning, ValidationResult as BlocksValidationResult, } from './validate.js';
|
|
4
|
+
export { layoutNestedBlocks, iterateBlocks } from './layout.js';
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { BlocksFile, BlocksLayout, BlocksLayoutOptions, LaidOutBlock } from './types.js';
|
|
2
|
+
export declare function layoutNestedBlocks(file: BlocksFile, options?: BlocksLayoutOptions): BlocksLayout;
|
|
3
|
+
/** Iterate every laid-out block (including nested children) in pre-order. */
|
|
4
|
+
export declare function iterateBlocks(layout: BlocksLayout): Iterable<LaidOutBlock>;
|