@principal-ai/subsystems-core 0.29.0 → 0.31.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.
Files changed (558) hide show
  1. package/README.md +15 -110
  2. package/dist/index.d.ts +7 -75
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +21 -205
  5. package/dist/index.js.map +1 -1
  6. package/dist/node.d.ts +5 -61
  7. package/dist/node.d.ts.map +1 -1
  8. package/dist/node.js +9 -131
  9. package/dist/node.js.map +1 -1
  10. package/dist/types/index.d.ts +3 -348
  11. package/dist/types/index.d.ts.map +1 -1
  12. package/dist/types/index.js +3 -19
  13. package/dist/types/index.js.map +1 -1
  14. package/dist/types/subsystem-model.d.ts +34 -3
  15. package/dist/types/subsystem-model.d.ts.map +1 -1
  16. package/dist/types/subsystem-model.js.map +1 -1
  17. package/package.json +7 -24
  18. package/schemas/subsystem-model.schema.json +52 -1
  19. package/src/index.ts +7 -580
  20. package/src/node.ts +21 -262
  21. package/src/types/index.ts +3 -456
  22. package/src/types/subsystem-model.ts +39 -3
  23. package/dist/ConfigurationLoader.d.ts +0 -76
  24. package/dist/ConfigurationLoader.d.ts.map +0 -1
  25. package/dist/ConfigurationLoader.js +0 -148
  26. package/dist/ConfigurationLoader.js.map +0 -1
  27. package/dist/ConfigurationValidator.d.ts +0 -31
  28. package/dist/ConfigurationValidator.d.ts.map +0 -1
  29. package/dist/ConfigurationValidator.js +0 -239
  30. package/dist/ConfigurationValidator.js.map +0 -1
  31. package/dist/EventProcessor.d.ts +0 -49
  32. package/dist/EventProcessor.d.ts.map +0 -1
  33. package/dist/EventProcessor.js +0 -220
  34. package/dist/EventProcessor.js.map +0 -1
  35. package/dist/EventRecorderService.d.ts +0 -305
  36. package/dist/EventRecorderService.d.ts.map +0 -1
  37. package/dist/EventRecorderService.js +0 -467
  38. package/dist/EventRecorderService.js.map +0 -1
  39. package/dist/LibraryLoader.d.ts +0 -65
  40. package/dist/LibraryLoader.d.ts.map +0 -1
  41. package/dist/LibraryLoader.js +0 -197
  42. package/dist/LibraryLoader.js.map +0 -1
  43. package/dist/PathBasedEventProcessor.d.ts +0 -77
  44. package/dist/PathBasedEventProcessor.d.ts.map +0 -1
  45. package/dist/PathBasedEventProcessor.js +0 -136
  46. package/dist/PathBasedEventProcessor.js.map +0 -1
  47. package/dist/SessionManager.d.ts +0 -194
  48. package/dist/SessionManager.d.ts.map +0 -1
  49. package/dist/SessionManager.js +0 -302
  50. package/dist/SessionManager.js.map +0 -1
  51. package/dist/ValidationEngine.d.ts +0 -31
  52. package/dist/ValidationEngine.d.ts.map +0 -1
  53. package/dist/ValidationEngine.js +0 -162
  54. package/dist/ValidationEngine.js.map +0 -1
  55. package/dist/auxiliary/AuxiliaryManifestValidator.d.ts +0 -41
  56. package/dist/auxiliary/AuxiliaryManifestValidator.d.ts.map +0 -1
  57. package/dist/auxiliary/AuxiliaryManifestValidator.js +0 -100
  58. package/dist/auxiliary/AuxiliaryManifestValidator.js.map +0 -1
  59. package/dist/auxiliary/index.d.ts +0 -9
  60. package/dist/auxiliary/index.d.ts.map +0 -1
  61. package/dist/auxiliary/index.js +0 -14
  62. package/dist/auxiliary/index.js.map +0 -1
  63. package/dist/auxiliary/validateAreaScopeDisjoint.d.ts +0 -24
  64. package/dist/auxiliary/validateAreaScopeDisjoint.d.ts.map +0 -1
  65. package/dist/auxiliary/validateAreaScopeDisjoint.js +0 -61
  66. package/dist/auxiliary/validateAreaScopeDisjoint.js.map +0 -1
  67. package/dist/cli/codegen.d.ts +0 -41
  68. package/dist/cli/codegen.d.ts.map +0 -1
  69. package/dist/cli/codegen.js +0 -257
  70. package/dist/cli/codegen.js.map +0 -1
  71. package/dist/codegen/type-generator.d.ts +0 -123
  72. package/dist/codegen/type-generator.d.ts.map +0 -1
  73. package/dist/codegen/type-generator.js +0 -433
  74. package/dist/codegen/type-generator.js.map +0 -1
  75. package/dist/codegen/usage-example.d.ts +0 -103
  76. package/dist/codegen/usage-example.d.ts.map +0 -1
  77. package/dist/codegen/usage-example.js +0 -258
  78. package/dist/codegen/usage-example.js.map +0 -1
  79. package/dist/dashboard/DashboardValidator.d.ts +0 -85
  80. package/dist/dashboard/DashboardValidator.d.ts.map +0 -1
  81. package/dist/dashboard/DashboardValidator.js +0 -775
  82. package/dist/dashboard/DashboardValidator.js.map +0 -1
  83. package/dist/dashboard/index.d.ts +0 -6
  84. package/dist/dashboard/index.d.ts.map +0 -1
  85. package/dist/dashboard/index.js +0 -10
  86. package/dist/dashboard/index.js.map +0 -1
  87. package/dist/discovery/CanvasDiscovery.d.ts +0 -160
  88. package/dist/discovery/CanvasDiscovery.d.ts.map +0 -1
  89. package/dist/discovery/CanvasDiscovery.js +0 -865
  90. package/dist/discovery/CanvasDiscovery.js.map +0 -1
  91. package/dist/discovery/CanvasFileManifest.d.ts +0 -86
  92. package/dist/discovery/CanvasFileManifest.d.ts.map +0 -1
  93. package/dist/discovery/CanvasFileManifest.js +0 -338
  94. package/dist/discovery/CanvasFileManifest.js.map +0 -1
  95. package/dist/discovery/LibraryDiscovery.d.ts +0 -108
  96. package/dist/discovery/LibraryDiscovery.d.ts.map +0 -1
  97. package/dist/discovery/LibraryDiscovery.js +0 -263
  98. package/dist/discovery/LibraryDiscovery.js.map +0 -1
  99. package/dist/discovery/types.d.ts +0 -403
  100. package/dist/discovery/types.d.ts.map +0 -1
  101. package/dist/discovery/types.js +0 -6
  102. package/dist/discovery/types.js.map +0 -1
  103. package/dist/events/EventsCanvasValidator.d.ts +0 -139
  104. package/dist/events/EventsCanvasValidator.d.ts.map +0 -1
  105. package/dist/events/EventsCanvasValidator.js +0 -281
  106. package/dist/events/EventsCanvasValidator.js.map +0 -1
  107. package/dist/events/NamespacePathIndex.d.ts +0 -61
  108. package/dist/events/NamespacePathIndex.d.ts.map +0 -1
  109. package/dist/events/NamespacePathIndex.js +0 -74
  110. package/dist/events/NamespacePathIndex.js.map +0 -1
  111. package/dist/events/OtelEventPathsValidator.d.ts +0 -75
  112. package/dist/events/OtelEventPathsValidator.d.ts.map +0 -1
  113. package/dist/events/OtelEventPathsValidator.js +0 -126
  114. package/dist/events/OtelEventPathsValidator.js.map +0 -1
  115. package/dist/events/ScopeEventsValidator.d.ts +0 -68
  116. package/dist/events/ScopeEventsValidator.d.ts.map +0 -1
  117. package/dist/events/ScopeEventsValidator.js +0 -91
  118. package/dist/events/ScopeEventsValidator.js.map +0 -1
  119. package/dist/events/index.d.ts +0 -9
  120. package/dist/events/index.d.ts.map +0 -1
  121. package/dist/events/index.js +0 -12
  122. package/dist/events/index.js.map +0 -1
  123. package/dist/events/path-helpers.d.ts +0 -33
  124. package/dist/events/path-helpers.d.ts.map +0 -1
  125. package/dist/events/path-helpers.js +0 -59
  126. package/dist/events/path-helpers.js.map +0 -1
  127. package/dist/execution/ExecutionLoader.d.ts +0 -135
  128. package/dist/execution/ExecutionLoader.d.ts.map +0 -1
  129. package/dist/execution/ExecutionLoader.js +0 -266
  130. package/dist/execution/ExecutionLoader.js.map +0 -1
  131. package/dist/execution/ExecutionValidator.d.ts +0 -94
  132. package/dist/execution/ExecutionValidator.d.ts.map +0 -1
  133. package/dist/execution/ExecutionValidator.js +0 -503
  134. package/dist/execution/ExecutionValidator.js.map +0 -1
  135. package/dist/generated/graph-converter-execution.types.d.ts +0 -177
  136. package/dist/generated/graph-converter-execution.types.d.ts.map +0 -1
  137. package/dist/generated/graph-converter-execution.types.js +0 -12
  138. package/dist/generated/graph-converter-execution.types.js.map +0 -1
  139. package/dist/helpers/GraphInstrumentationHelper.d.ts +0 -93
  140. package/dist/helpers/GraphInstrumentationHelper.d.ts.map +0 -1
  141. package/dist/helpers/GraphInstrumentationHelper.js +0 -252
  142. package/dist/helpers/GraphInstrumentationHelper.js.map +0 -1
  143. package/dist/matchers/SpanMatcher.d.ts +0 -107
  144. package/dist/matchers/SpanMatcher.d.ts.map +0 -1
  145. package/dist/matchers/SpanMatcher.js +0 -274
  146. package/dist/matchers/SpanMatcher.js.map +0 -1
  147. package/dist/orchestration/TraceOrchestrator.d.ts +0 -71
  148. package/dist/orchestration/TraceOrchestrator.d.ts.map +0 -1
  149. package/dist/orchestration/TraceOrchestrator.js +0 -416
  150. package/dist/orchestration/TraceOrchestrator.js.map +0 -1
  151. package/dist/parsers/OtlpTraceParser.d.ts +0 -131
  152. package/dist/parsers/OtlpTraceParser.d.ts.map +0 -1
  153. package/dist/parsers/OtlpTraceParser.js +0 -310
  154. package/dist/parsers/OtlpTraceParser.js.map +0 -1
  155. package/dist/registry/CompositeRegistry.d.ts +0 -71
  156. package/dist/registry/CompositeRegistry.d.ts.map +0 -1
  157. package/dist/registry/CompositeRegistry.js +0 -113
  158. package/dist/registry/CompositeRegistry.js.map +0 -1
  159. package/dist/registry/EventRegistry.d.ts +0 -79
  160. package/dist/registry/EventRegistry.d.ts.map +0 -1
  161. package/dist/registry/EventRegistry.js +0 -165
  162. package/dist/registry/EventRegistry.js.map +0 -1
  163. package/dist/registry/LocalRegistry.d.ts +0 -111
  164. package/dist/registry/LocalRegistry.d.ts.map +0 -1
  165. package/dist/registry/LocalRegistry.js +0 -335
  166. package/dist/registry/LocalRegistry.js.map +0 -1
  167. package/dist/registry/RemoteRegistry.d.ts +0 -122
  168. package/dist/registry/RemoteRegistry.d.ts.map +0 -1
  169. package/dist/registry/RemoteRegistry.js +0 -399
  170. package/dist/registry/RemoteRegistry.js.map +0 -1
  171. package/dist/registry/VersionRegistry.d.ts +0 -51
  172. package/dist/registry/VersionRegistry.d.ts.map +0 -1
  173. package/dist/registry/VersionRegistry.js +0 -105
  174. package/dist/registry/VersionRegistry.js.map +0 -1
  175. package/dist/rules/config.d.ts +0 -57
  176. package/dist/rules/config.d.ts.map +0 -1
  177. package/dist/rules/config.js +0 -382
  178. package/dist/rules/config.js.map +0 -1
  179. package/dist/rules/engine.d.ts +0 -70
  180. package/dist/rules/engine.d.ts.map +0 -1
  181. package/dist/rules/engine.js +0 -373
  182. package/dist/rules/engine.js.map +0 -1
  183. package/dist/rules/implementations/connection-type-references.d.ts +0 -7
  184. package/dist/rules/implementations/connection-type-references.d.ts.map +0 -1
  185. package/dist/rules/implementations/connection-type-references.js +0 -107
  186. package/dist/rules/implementations/connection-type-references.js.map +0 -1
  187. package/dist/rules/implementations/dead-end-states.d.ts +0 -17
  188. package/dist/rules/implementations/dead-end-states.d.ts.map +0 -1
  189. package/dist/rules/implementations/dead-end-states.js +0 -75
  190. package/dist/rules/implementations/dead-end-states.js.map +0 -1
  191. package/dist/rules/implementations/index.d.ts +0 -23
  192. package/dist/rules/implementations/index.d.ts.map +0 -1
  193. package/dist/rules/implementations/index.js +0 -73
  194. package/dist/rules/implementations/index.js.map +0 -1
  195. package/dist/rules/implementations/minimum-node-sources.d.ts +0 -24
  196. package/dist/rules/implementations/minimum-node-sources.d.ts.map +0 -1
  197. package/dist/rules/implementations/minimum-node-sources.js +0 -59
  198. package/dist/rules/implementations/minimum-node-sources.js.map +0 -1
  199. package/dist/rules/implementations/no-unknown-fields.d.ts +0 -7
  200. package/dist/rules/implementations/no-unknown-fields.d.ts.map +0 -1
  201. package/dist/rules/implementations/no-unknown-fields.js +0 -216
  202. package/dist/rules/implementations/no-unknown-fields.js.map +0 -1
  203. package/dist/rules/implementations/orphaned-edge-types.d.ts +0 -7
  204. package/dist/rules/implementations/orphaned-edge-types.d.ts.map +0 -1
  205. package/dist/rules/implementations/orphaned-edge-types.js +0 -50
  206. package/dist/rules/implementations/orphaned-edge-types.js.map +0 -1
  207. package/dist/rules/implementations/orphaned-node-types.d.ts +0 -7
  208. package/dist/rules/implementations/orphaned-node-types.d.ts.map +0 -1
  209. package/dist/rules/implementations/orphaned-node-types.js +0 -53
  210. package/dist/rules/implementations/orphaned-node-types.js.map +0 -1
  211. package/dist/rules/implementations/required-metadata.d.ts +0 -7
  212. package/dist/rules/implementations/required-metadata.d.ts.map +0 -1
  213. package/dist/rules/implementations/required-metadata.js +0 -48
  214. package/dist/rules/implementations/required-metadata.js.map +0 -1
  215. package/dist/rules/implementations/state-transition-references.d.ts +0 -7
  216. package/dist/rules/implementations/state-transition-references.d.ts.map +0 -1
  217. package/dist/rules/implementations/state-transition-references.js +0 -138
  218. package/dist/rules/implementations/state-transition-references.js.map +0 -1
  219. package/dist/rules/implementations/unreachable-states.d.ts +0 -7
  220. package/dist/rules/implementations/unreachable-states.d.ts.map +0 -1
  221. package/dist/rules/implementations/unreachable-states.js +0 -83
  222. package/dist/rules/implementations/unreachable-states.js.map +0 -1
  223. package/dist/rules/implementations/valid-action-patterns.d.ts +0 -17
  224. package/dist/rules/implementations/valid-action-patterns.d.ts.map +0 -1
  225. package/dist/rules/implementations/valid-action-patterns.js +0 -112
  226. package/dist/rules/implementations/valid-action-patterns.js.map +0 -1
  227. package/dist/rules/implementations/valid-color-format.d.ts +0 -7
  228. package/dist/rules/implementations/valid-color-format.d.ts.map +0 -1
  229. package/dist/rules/implementations/valid-color-format.js +0 -94
  230. package/dist/rules/implementations/valid-color-format.js.map +0 -1
  231. package/dist/rules/implementations/valid-edge-types.d.ts +0 -7
  232. package/dist/rules/implementations/valid-edge-types.d.ts.map +0 -1
  233. package/dist/rules/implementations/valid-edge-types.js +0 -248
  234. package/dist/rules/implementations/valid-edge-types.js.map +0 -1
  235. package/dist/rules/implementations/valid-node-types.d.ts +0 -7
  236. package/dist/rules/implementations/valid-node-types.d.ts.map +0 -1
  237. package/dist/rules/implementations/valid-node-types.js +0 -187
  238. package/dist/rules/implementations/valid-node-types.js.map +0 -1
  239. package/dist/rules/index.d.ts +0 -28
  240. package/dist/rules/index.d.ts.map +0 -1
  241. package/dist/rules/index.js +0 -70
  242. package/dist/rules/index.js.map +0 -1
  243. package/dist/rules/types.d.ts +0 -309
  244. package/dist/rules/types.d.ts.map +0 -1
  245. package/dist/rules/types.js +0 -40
  246. package/dist/rules/types.js.map +0 -1
  247. package/dist/scopes/ScopePathIndex.d.ts +0 -56
  248. package/dist/scopes/ScopePathIndex.d.ts.map +0 -1
  249. package/dist/scopes/ScopePathIndex.js +0 -67
  250. package/dist/scopes/ScopePathIndex.js.map +0 -1
  251. package/dist/scopes/ScopesCanvasValidator.d.ts +0 -76
  252. package/dist/scopes/ScopesCanvasValidator.d.ts.map +0 -1
  253. package/dist/scopes/ScopesCanvasValidator.js +0 -221
  254. package/dist/scopes/ScopesCanvasValidator.js.map +0 -1
  255. package/dist/scopes/index.d.ts +0 -12
  256. package/dist/scopes/index.d.ts.map +0 -1
  257. package/dist/scopes/index.js +0 -30
  258. package/dist/scopes/index.js.map +0 -1
  259. package/dist/scopes/utils.d.ts +0 -85
  260. package/dist/scopes/utils.d.ts.map +0 -1
  261. package/dist/scopes/utils.js +0 -143
  262. package/dist/scopes/utils.js.map +0 -1
  263. package/dist/scopes/validateScopeNamespaceNesting.d.ts +0 -38
  264. package/dist/scopes/validateScopeNamespaceNesting.d.ts.map +0 -1
  265. package/dist/scopes/validateScopeNamespaceNesting.js +0 -69
  266. package/dist/scopes/validateScopeNamespaceNesting.js.map +0 -1
  267. package/dist/spans/index.d.ts +0 -12
  268. package/dist/spans/index.d.ts.map +0 -1
  269. package/dist/spans/index.js +0 -25
  270. package/dist/spans/index.js.map +0 -1
  271. package/dist/spans/utils.d.ts +0 -70
  272. package/dist/spans/utils.d.ts.map +0 -1
  273. package/dist/spans/utils.js +0 -205
  274. package/dist/spans/utils.js.map +0 -1
  275. package/dist/storyboard/builder.d.ts +0 -135
  276. package/dist/storyboard/builder.d.ts.map +0 -1
  277. package/dist/storyboard/builder.js +0 -235
  278. package/dist/storyboard/builder.js.map +0 -1
  279. package/dist/storyboard/index.d.ts +0 -9
  280. package/dist/storyboard/index.d.ts.map +0 -1
  281. package/dist/storyboard/index.js +0 -18
  282. package/dist/storyboard/index.js.map +0 -1
  283. package/dist/storyboard/types.d.ts +0 -101
  284. package/dist/storyboard/types.d.ts.map +0 -1
  285. package/dist/storyboard/types.js +0 -10
  286. package/dist/storyboard/types.js.map +0 -1
  287. package/dist/telemetry/coverage.d.ts +0 -92
  288. package/dist/telemetry/coverage.d.ts.map +0 -1
  289. package/dist/telemetry/coverage.js +0 -335
  290. package/dist/telemetry/coverage.js.map +0 -1
  291. package/dist/telemetry/event-validator.d.ts +0 -86
  292. package/dist/telemetry/event-validator.d.ts.map +0 -1
  293. package/dist/telemetry/event-validator.js +0 -257
  294. package/dist/telemetry/event-validator.js.map +0 -1
  295. package/dist/types/audit.d.ts +0 -236
  296. package/dist/types/audit.d.ts.map +0 -1
  297. package/dist/types/audit.js +0 -53
  298. package/dist/types/audit.js.map +0 -1
  299. package/dist/types/auxiliary.d.ts +0 -54
  300. package/dist/types/auxiliary.d.ts.map +0 -1
  301. package/dist/types/auxiliary.js +0 -27
  302. package/dist/types/auxiliary.js.map +0 -1
  303. package/dist/types/canvas-scope.d.ts +0 -156
  304. package/dist/types/canvas-scope.d.ts.map +0 -1
  305. package/dist/types/canvas-scope.js +0 -62
  306. package/dist/types/canvas-scope.js.map +0 -1
  307. package/dist/types/canvas.d.ts +0 -1138
  308. package/dist/types/canvas.d.ts.map +0 -1
  309. package/dist/types/canvas.js +0 -178
  310. package/dist/types/canvas.js.map +0 -1
  311. package/dist/types/dashboard.d.ts +0 -170
  312. package/dist/types/dashboard.d.ts.map +0 -1
  313. package/dist/types/dashboard.js +0 -14
  314. package/dist/types/dashboard.js.map +0 -1
  315. package/dist/types/library.d.ts +0 -227
  316. package/dist/types/library.d.ts.map +0 -1
  317. package/dist/types/library.js +0 -16
  318. package/dist/types/library.js.map +0 -1
  319. package/dist/types/otel.d.ts +0 -465
  320. package/dist/types/otel.d.ts.map +0 -1
  321. package/dist/types/otel.js +0 -163
  322. package/dist/types/otel.js.map +0 -1
  323. package/dist/types/path-based-config.d.ts +0 -235
  324. package/dist/types/path-based-config.d.ts.map +0 -1
  325. package/dist/types/path-based-config.js +0 -11
  326. package/dist/types/path-based-config.js.map +0 -1
  327. package/dist/types/registered-trace.d.ts +0 -337
  328. package/dist/types/registered-trace.d.ts.map +0 -1
  329. package/dist/types/registered-trace.js +0 -16
  330. package/dist/types/registered-trace.js.map +0 -1
  331. package/dist/types/resource-match.d.ts +0 -207
  332. package/dist/types/resource-match.d.ts.map +0 -1
  333. package/dist/types/resource-match.js +0 -74
  334. package/dist/types/resource-match.js.map +0 -1
  335. package/dist/types/version-registry.d.ts +0 -137
  336. package/dist/types/version-registry.d.ts.map +0 -1
  337. package/dist/types/version-registry.js +0 -10
  338. package/dist/types/version-registry.js.map +0 -1
  339. package/dist/utils/CanvasConverter.d.ts +0 -148
  340. package/dist/utils/CanvasConverter.d.ts.map +0 -1
  341. package/dist/utils/CanvasConverter.js +0 -530
  342. package/dist/utils/CanvasConverter.js.map +0 -1
  343. package/dist/utils/GraphConverter.d.ts +0 -18
  344. package/dist/utils/GraphConverter.d.ts.map +0 -1
  345. package/dist/utils/GraphConverter.js +0 -80
  346. package/dist/utils/GraphConverter.js.map +0 -1
  347. package/dist/utils/PathMatcher.d.ts +0 -55
  348. package/dist/utils/PathMatcher.d.ts.map +0 -1
  349. package/dist/utils/PathMatcher.js +0 -178
  350. package/dist/utils/PathMatcher.js.map +0 -1
  351. package/dist/utils/TraceToCanvas.d.ts +0 -83
  352. package/dist/utils/TraceToCanvas.d.ts.map +0 -1
  353. package/dist/utils/TraceToCanvas.js +0 -336
  354. package/dist/utils/TraceToCanvas.js.map +0 -1
  355. package/dist/utils/YamlParser.d.ts +0 -36
  356. package/dist/utils/YamlParser.d.ts.map +0 -1
  357. package/dist/utils/YamlParser.js +0 -92
  358. package/dist/utils/YamlParser.js.map +0 -1
  359. package/dist/utils/registeredTraceHelpers.d.ts +0 -76
  360. package/dist/utils/registeredTraceHelpers.d.ts.map +0 -1
  361. package/dist/utils/registeredTraceHelpers.js +0 -203
  362. package/dist/utils/registeredTraceHelpers.js.map +0 -1
  363. package/dist/utils/traceAggregation.d.ts +0 -25
  364. package/dist/utils/traceAggregation.d.ts.map +0 -1
  365. package/dist/utils/traceAggregation.js +0 -140
  366. package/dist/utils/traceAggregation.js.map +0 -1
  367. package/dist/validation/OtelCanvasValidator.d.ts +0 -40
  368. package/dist/validation/OtelCanvasValidator.d.ts.map +0 -1
  369. package/dist/validation/OtelCanvasValidator.js +0 -59
  370. package/dist/validation/OtelCanvasValidator.js.map +0 -1
  371. package/dist/validation/index.d.ts +0 -8
  372. package/dist/validation/index.d.ts.map +0 -1
  373. package/dist/validation/index.js +0 -13
  374. package/dist/validation/index.js.map +0 -1
  375. package/dist/validation/libraryValidation.d.ts +0 -53
  376. package/dist/validation/libraryValidation.d.ts.map +0 -1
  377. package/dist/validation/libraryValidation.js +0 -115
  378. package/dist/validation/libraryValidation.js.map +0 -1
  379. package/dist/workflow/edge-derivation.d.ts +0 -111
  380. package/dist/workflow/edge-derivation.d.ts.map +0 -1
  381. package/dist/workflow/edge-derivation.js +0 -174
  382. package/dist/workflow/edge-derivation.js.map +0 -1
  383. package/dist/workflow/edge-validation.d.ts +0 -170
  384. package/dist/workflow/edge-validation.d.ts.map +0 -1
  385. package/dist/workflow/edge-validation.js +0 -332
  386. package/dist/workflow/edge-validation.js.map +0 -1
  387. package/dist/workflow/example.d.ts +0 -11
  388. package/dist/workflow/example.d.ts.map +0 -1
  389. package/dist/workflow/example.js +0 -310
  390. package/dist/workflow/example.js.map +0 -1
  391. package/dist/workflow/index.d.ts +0 -20
  392. package/dist/workflow/index.d.ts.map +0 -1
  393. package/dist/workflow/index.js +0 -49
  394. package/dist/workflow/index.js.map +0 -1
  395. package/dist/workflow/scenario-matcher.d.ts +0 -63
  396. package/dist/workflow/scenario-matcher.d.ts.map +0 -1
  397. package/dist/workflow/scenario-matcher.js +0 -215
  398. package/dist/workflow/scenario-matcher.js.map +0 -1
  399. package/dist/workflow/template-parser.d.ts +0 -73
  400. package/dist/workflow/template-parser.d.ts.map +0 -1
  401. package/dist/workflow/template-parser.js +0 -280
  402. package/dist/workflow/template-parser.js.map +0 -1
  403. package/dist/workflow/template-renderer.d.ts +0 -45
  404. package/dist/workflow/template-renderer.d.ts.map +0 -1
  405. package/dist/workflow/template-renderer.js +0 -401
  406. package/dist/workflow/template-renderer.js.map +0 -1
  407. package/dist/workflow/types.d.ts +0 -393
  408. package/dist/workflow/types.d.ts.map +0 -1
  409. package/dist/workflow/types.js +0 -40
  410. package/dist/workflow/types.js.map +0 -1
  411. package/dist/workflow/validator.d.ts +0 -363
  412. package/dist/workflow/validator.d.ts.map +0 -1
  413. package/dist/workflow/validator.js +0 -2283
  414. package/dist/workflow/validator.js.map +0 -1
  415. package/schemas/auxiliary.manifest.schema.json +0 -56
  416. package/src/ConfigurationLoader.test.ts +0 -466
  417. package/src/ConfigurationLoader.ts +0 -184
  418. package/src/ConfigurationValidator.test.ts +0 -200
  419. package/src/ConfigurationValidator.ts +0 -273
  420. package/src/EventProcessor.test.ts +0 -405
  421. package/src/EventProcessor.ts +0 -256
  422. package/src/EventRecorderService.test.ts +0 -543
  423. package/src/EventRecorderService.ts +0 -741
  424. package/src/LibraryLoader.ts +0 -194
  425. package/src/PathBasedEventProcessor.test.ts +0 -336
  426. package/src/PathBasedEventProcessor.ts +0 -196
  427. package/src/SessionManager.test.ts +0 -424
  428. package/src/SessionManager.ts +0 -471
  429. package/src/ValidationEngine.test.ts +0 -520
  430. package/src/ValidationEngine.ts +0 -200
  431. package/src/auxiliary/AuxiliaryManifestValidator.test.ts +0 -93
  432. package/src/auxiliary/AuxiliaryManifestValidator.ts +0 -132
  433. package/src/auxiliary/index.ts +0 -18
  434. package/src/auxiliary/validateAreaScopeDisjoint.test.ts +0 -85
  435. package/src/auxiliary/validateAreaScopeDisjoint.ts +0 -72
  436. package/src/cli/codegen.ts +0 -286
  437. package/src/codegen/type-generator.test.ts +0 -219
  438. package/src/codegen/type-generator.ts +0 -560
  439. package/src/codegen/usage-example.ts +0 -357
  440. package/src/dashboard/DashboardValidator.ts +0 -904
  441. package/src/dashboard/index.ts +0 -14
  442. package/src/discovery/CanvasDiscovery.test.ts +0 -691
  443. package/src/discovery/CanvasDiscovery.ts +0 -1114
  444. package/src/discovery/CanvasFileManifest.test.ts +0 -521
  445. package/src/discovery/CanvasFileManifest.ts +0 -419
  446. package/src/discovery/LibraryDiscovery.test.ts +0 -329
  447. package/src/discovery/LibraryDiscovery.ts +0 -386
  448. package/src/discovery/types.ts +0 -453
  449. package/src/events/EventsCanvasValidator.test.ts +0 -191
  450. package/src/events/EventsCanvasValidator.ts +0 -428
  451. package/src/events/NamespacePathIndex.test.ts +0 -97
  452. package/src/events/NamespacePathIndex.ts +0 -100
  453. package/src/events/OtelEventPathsValidator.test.ts +0 -243
  454. package/src/events/OtelEventPathsValidator.ts +0 -191
  455. package/src/events/ScopeEventsValidator.test.ts +0 -173
  456. package/src/events/ScopeEventsValidator.ts +0 -158
  457. package/src/events/index.ts +0 -27
  458. package/src/events/path-helpers.ts +0 -53
  459. package/src/execution/ExecutionLoader.test.ts +0 -378
  460. package/src/execution/ExecutionLoader.ts +0 -331
  461. package/src/execution/ExecutionValidator.test.ts +0 -503
  462. package/src/execution/ExecutionValidator.ts +0 -617
  463. package/src/generated/graph-converter-execution.types.ts +0 -193
  464. package/src/helpers/GraphInstrumentationHelper.test.ts +0 -364
  465. package/src/helpers/GraphInstrumentationHelper.ts +0 -323
  466. package/src/matchers/SpanMatcher.test.ts +0 -1105
  467. package/src/matchers/SpanMatcher.ts +0 -381
  468. package/src/orchestration/TraceOrchestrator.ts +0 -560
  469. package/src/orchestration/__tests__/TraceOrchestrator.test.ts +0 -1098
  470. package/src/parsers/OtlpTraceParser.ts +0 -401
  471. package/src/parsers/__tests__/OtlpTraceParser.test.ts +0 -197
  472. package/src/registry/CompositeRegistry.ts +0 -140
  473. package/src/registry/EventRegistry.test.ts +0 -387
  474. package/src/registry/EventRegistry.ts +0 -191
  475. package/src/registry/LocalRegistry.ts +0 -416
  476. package/src/registry/RemoteRegistry.ts +0 -499
  477. package/src/registry/VersionRegistry.test.ts +0 -223
  478. package/src/registry/VersionRegistry.ts +0 -121
  479. package/src/rules/config.test.ts +0 -277
  480. package/src/rules/config.ts +0 -450
  481. package/src/rules/engine.test.ts +0 -331
  482. package/src/rules/engine.ts +0 -448
  483. package/src/rules/implementations/connection-type-references.ts +0 -117
  484. package/src/rules/implementations/dead-end-states.ts +0 -101
  485. package/src/rules/implementations/index.ts +0 -66
  486. package/src/rules/implementations/minimum-node-sources.ts +0 -84
  487. package/src/rules/implementations/no-unknown-fields.ts +0 -372
  488. package/src/rules/implementations/orphaned-edge-types.ts +0 -55
  489. package/src/rules/implementations/orphaned-node-types.ts +0 -58
  490. package/src/rules/implementations/required-metadata.ts +0 -52
  491. package/src/rules/implementations/state-transition-references.ts +0 -155
  492. package/src/rules/implementations/unreachable-states.ts +0 -94
  493. package/src/rules/implementations/valid-action-patterns.ts +0 -140
  494. package/src/rules/implementations/valid-color-format.ts +0 -152
  495. package/src/rules/implementations/valid-edge-types.ts +0 -273
  496. package/src/rules/implementations/valid-node-types.ts +0 -200
  497. package/src/rules/index.ts +0 -92
  498. package/src/rules/types.ts +0 -426
  499. package/src/scopes/ScopePathIndex.test.ts +0 -94
  500. package/src/scopes/ScopePathIndex.ts +0 -89
  501. package/src/scopes/ScopesCanvasValidator.test.ts +0 -127
  502. package/src/scopes/ScopesCanvasValidator.ts +0 -305
  503. package/src/scopes/__tests__/utils.test.ts +0 -383
  504. package/src/scopes/index.ts +0 -42
  505. package/src/scopes/utils.ts +0 -182
  506. package/src/scopes/validateScopeNamespaceNesting.test.ts +0 -127
  507. package/src/scopes/validateScopeNamespaceNesting.ts +0 -88
  508. package/src/spans/index.ts +0 -24
  509. package/src/spans/utils.ts +0 -249
  510. package/src/storyboard/builder.ts +0 -308
  511. package/src/storyboard/index.ts +0 -26
  512. package/src/storyboard/types.ts +0 -117
  513. package/src/telemetry/coverage.ts +0 -480
  514. package/src/telemetry/event-validator.ts +0 -312
  515. package/src/types/audit.ts +0 -314
  516. package/src/types/auxiliary.ts +0 -63
  517. package/src/types/canvas-scope.ts +0 -190
  518. package/src/types/canvas.test.ts +0 -199
  519. package/src/types/canvas.ts +0 -1395
  520. package/src/types/dashboard.ts +0 -257
  521. package/src/types/library.ts +0 -283
  522. package/src/types/otel.test.ts +0 -219
  523. package/src/types/otel.ts +0 -620
  524. package/src/types/path-based-config.ts +0 -285
  525. package/src/types/registered-trace.ts +0 -432
  526. package/src/types/resource-match.ts +0 -263
  527. package/src/types/version-registry.ts +0 -150
  528. package/src/utils/CanvasConverter.ts +0 -670
  529. package/src/utils/GraphConverter.test.ts +0 -322
  530. package/src/utils/GraphConverter.ts +0 -84
  531. package/src/utils/PathMatcher.test.ts +0 -139
  532. package/src/utils/PathMatcher.ts +0 -185
  533. package/src/utils/TraceToCanvas.test.ts +0 -310
  534. package/src/utils/TraceToCanvas.ts +0 -510
  535. package/src/utils/YamlParser.ts +0 -77
  536. package/src/utils/registeredTraceHelpers.ts +0 -251
  537. package/src/utils/traceAggregation.test.ts +0 -385
  538. package/src/utils/traceAggregation.ts +0 -173
  539. package/src/validation/OtelCanvasValidator.ts +0 -86
  540. package/src/validation/index.ts +0 -17
  541. package/src/validation/libraryValidation.ts +0 -206
  542. package/src/workflow/README.md +0 -408
  543. package/src/workflow/__tests__/edge-derivation.test.ts +0 -449
  544. package/src/workflow/__tests__/edge-validation.test.ts +0 -417
  545. package/src/workflow/__tests__/scenario-matcher.test.ts +0 -225
  546. package/src/workflow/__tests__/template-parser.test.ts +0 -276
  547. package/src/workflow/__tests__/template-renderer.test.ts +0 -509
  548. package/src/workflow/__tests__/types.test.ts +0 -187
  549. package/src/workflow/__tests__/validator.test.ts +0 -3225
  550. package/src/workflow/edge-derivation.ts +0 -265
  551. package/src/workflow/edge-validation.ts +0 -503
  552. package/src/workflow/example.ts +0 -330
  553. package/src/workflow/index.ts +0 -86
  554. package/src/workflow/scenario-matcher.ts +0 -253
  555. package/src/workflow/template-parser.ts +0 -350
  556. package/src/workflow/template-renderer.ts +0 -453
  557. package/src/workflow/types.ts +0 -511
  558. package/src/workflow/validator.ts +0 -2737
@@ -1,904 +0,0 @@
1
- /**
2
- * Dashboard File Validator
3
- *
4
- * Validates dashboard definition files (.dashboard.json) that define metrics,
5
- * layout, and data sources for observability dashboards.
6
- */
7
-
8
- import type {
9
- DashboardDefinition,
10
- MetricDefinition,
11
- MetricType,
12
- MetricSource,
13
- MetricQuery,
14
- Derivation,
15
- TimeGroup,
16
- MetricDisplay,
17
- DisplayComponent,
18
- DashboardLayout,
19
- DashboardRow,
20
- PanelPlacement,
21
- } from '../types/dashboard';
22
-
23
- /**
24
- * Validation error details
25
- */
26
- export interface DashboardValidationError {
27
- path: string;
28
- message: string;
29
- severity: 'error' | 'warning';
30
- suggestion?: string;
31
- }
32
-
33
- /**
34
- * Validation result
35
- */
36
- export interface DashboardValidationResult {
37
- valid: boolean;
38
- errors: DashboardValidationError[];
39
- warnings: DashboardValidationError[];
40
- }
41
-
42
- /**
43
- * Context for cross-reference validation (optional)
44
- */
45
- export interface DashboardValidationContext {
46
- /** Known storyboard names for source validation */
47
- storyboards?: string[];
48
- /** Known workflow names per storyboard */
49
- workflows?: Record<string, string[]>;
50
- /** Known event names */
51
- events?: string[];
52
- }
53
-
54
- // Valid metric types
55
- const VALID_METRIC_TYPES: MetricType[] = ['counter', 'gauge', 'histogram'];
56
-
57
- // Valid derivations
58
- const VALID_DERIVATIONS: Derivation[] = [
59
- 'count',
60
- 'rate',
61
- 'sum',
62
- 'avg',
63
- 'min',
64
- 'max',
65
- 'duration',
66
- 'error_rate',
67
- 'success_rate',
68
- 'percentage',
69
- 'p50',
70
- 'p95',
71
- 'p99',
72
- ];
73
-
74
- // Valid time groups
75
- const VALID_TIME_GROUPS: TimeGroup[] = ['minute', 'hour', 'day', 'week', 'month'];
76
-
77
- // Valid display components
78
- const VALID_DISPLAY_COMPONENTS: DisplayComponent[] = [
79
- 'MetricCard',
80
- 'LineChart',
81
- 'BarChart',
82
- 'StackedBarChart',
83
- 'PieChart',
84
- 'GaugeChart',
85
- 'Histogram',
86
- 'DataTable',
87
- ];
88
-
89
- /**
90
- * Validator for dashboard definition files
91
- */
92
- export class DashboardValidator {
93
- /**
94
- * Validate dashboard definition structure
95
- */
96
- validate(
97
- data: unknown,
98
- filePath?: string,
99
- context?: DashboardValidationContext
100
- ): DashboardValidationResult {
101
- const errors: DashboardValidationError[] = [];
102
- const warnings: DashboardValidationError[] = [];
103
-
104
- // Check if data is an object
105
- if (!data || typeof data !== 'object') {
106
- errors.push({
107
- path: filePath || 'root',
108
- message: 'Dashboard data must be an object',
109
- severity: 'error',
110
- suggestion: 'Expected format: { "id": "...", "name": "...", "metrics": [...], "layout": {...} }',
111
- });
112
- return { valid: false, errors, warnings };
113
- }
114
-
115
- // Check if it's an array (common mistake)
116
- if (Array.isArray(data)) {
117
- errors.push({
118
- path: filePath || 'root',
119
- message: 'Dashboard data should be an object, not an array',
120
- severity: 'error',
121
- });
122
- return { valid: false, errors, warnings };
123
- }
124
-
125
- const dashboard = data as Partial<DashboardDefinition>;
126
-
127
- // Validate required fields
128
- if (!dashboard.id) {
129
- errors.push({
130
- path: 'id',
131
- message: 'Missing required "id" field',
132
- severity: 'error',
133
- suggestion: 'Add a unique kebab-case identifier, e.g., "service-health"',
134
- });
135
- } else if (typeof dashboard.id !== 'string') {
136
- errors.push({
137
- path: 'id',
138
- message: '"id" must be a string',
139
- severity: 'error',
140
- });
141
- } else if (!/^[a-z0-9-]+$/.test(dashboard.id)) {
142
- warnings.push({
143
- path: 'id',
144
- message: 'Dashboard "id" should be kebab-case (lowercase with hyphens)',
145
- severity: 'warning',
146
- suggestion: `Consider renaming to "${dashboard.id.toLowerCase().replace(/[^a-z0-9]+/g, '-')}"`,
147
- });
148
- }
149
-
150
- if (!dashboard.name) {
151
- errors.push({
152
- path: 'name',
153
- message: 'Missing required "name" field',
154
- severity: 'error',
155
- suggestion: 'Add a human-readable name, e.g., "Service Health Dashboard"',
156
- });
157
- } else if (typeof dashboard.name !== 'string') {
158
- errors.push({
159
- path: 'name',
160
- message: '"name" must be a string',
161
- severity: 'error',
162
- });
163
- }
164
-
165
- // Validate optional description
166
- if (dashboard.description !== undefined && typeof dashboard.description !== 'string') {
167
- errors.push({
168
- path: 'description',
169
- message: '"description" must be a string',
170
- severity: 'error',
171
- });
172
- }
173
-
174
- // Validate metrics array
175
- if (!dashboard.metrics) {
176
- errors.push({
177
- path: 'metrics',
178
- message: 'Missing required "metrics" array',
179
- severity: 'error',
180
- suggestion: 'Add at least one metric definition',
181
- });
182
- } else if (!Array.isArray(dashboard.metrics)) {
183
- errors.push({
184
- path: 'metrics',
185
- message: '"metrics" must be an array',
186
- severity: 'error',
187
- });
188
- } else if (dashboard.metrics.length === 0) {
189
- warnings.push({
190
- path: 'metrics',
191
- message: 'Dashboard has no metrics defined',
192
- severity: 'warning',
193
- suggestion: 'Add at least one metric to make the dashboard useful',
194
- });
195
- } else {
196
- // Validate each metric
197
- const metricIds = new Set<string>();
198
- dashboard.metrics.forEach((metric, index) => {
199
- this.validateMetric(metric, index, errors, warnings, context);
200
-
201
- // Check for duplicate metric IDs
202
- if (metric.id) {
203
- if (metricIds.has(metric.id)) {
204
- errors.push({
205
- path: `metrics[${index}].id`,
206
- message: `Duplicate metric ID: "${metric.id}"`,
207
- severity: 'error',
208
- suggestion: 'Each metric must have a unique ID',
209
- });
210
- }
211
- metricIds.add(metric.id);
212
- }
213
- });
214
- }
215
-
216
- // Validate layout
217
- if (!dashboard.layout) {
218
- errors.push({
219
- path: 'layout',
220
- message: 'Missing required "layout" object',
221
- severity: 'error',
222
- suggestion: 'Add layout with columns and rows',
223
- });
224
- } else if (typeof dashboard.layout !== 'object' || Array.isArray(dashboard.layout)) {
225
- errors.push({
226
- path: 'layout',
227
- message: '"layout" must be an object',
228
- severity: 'error',
229
- });
230
- } else {
231
- // Get metric IDs for panel validation
232
- const metricIds = new Set(
233
- (dashboard.metrics || [])
234
- .filter((m): m is MetricDefinition => !!m && typeof m === 'object' && !!m.id)
235
- .map((m) => m.id)
236
- );
237
- this.validateLayout(dashboard.layout, errors, warnings, metricIds);
238
- }
239
-
240
- return {
241
- valid: errors.length === 0,
242
- errors,
243
- warnings,
244
- };
245
- }
246
-
247
- /**
248
- * Validate a single metric definition
249
- */
250
- private validateMetric(
251
- metric: unknown,
252
- index: number,
253
- errors: DashboardValidationError[],
254
- warnings: DashboardValidationError[],
255
- context?: DashboardValidationContext
256
- ): void {
257
- const metricPath = `metrics[${index}]`;
258
-
259
- if (!metric || typeof metric !== 'object') {
260
- errors.push({
261
- path: metricPath,
262
- message: 'Metric must be an object',
263
- severity: 'error',
264
- });
265
- return;
266
- }
267
-
268
- const m = metric as Partial<MetricDefinition>;
269
-
270
- // Required: id
271
- if (!m.id) {
272
- errors.push({
273
- path: `${metricPath}.id`,
274
- message: 'Metric is missing required "id" field',
275
- severity: 'error',
276
- suggestion: `Add unique ID like "metric-${index + 1}"`,
277
- });
278
- } else if (typeof m.id !== 'string') {
279
- errors.push({
280
- path: `${metricPath}.id`,
281
- message: 'Metric "id" must be a string',
282
- severity: 'error',
283
- });
284
- } else if (!/^[a-z0-9-]+$/.test(m.id)) {
285
- warnings.push({
286
- path: `${metricPath}.id`,
287
- message: 'Metric "id" should be kebab-case',
288
- severity: 'warning',
289
- });
290
- }
291
-
292
- // Required: name
293
- if (!m.name) {
294
- errors.push({
295
- path: `${metricPath}.name`,
296
- message: 'Metric is missing required "name" field',
297
- severity: 'error',
298
- });
299
- } else if (typeof m.name !== 'string') {
300
- errors.push({
301
- path: `${metricPath}.name`,
302
- message: 'Metric "name" must be a string',
303
- severity: 'error',
304
- });
305
- }
306
-
307
- // Required: type
308
- if (!m.type) {
309
- errors.push({
310
- path: `${metricPath}.type`,
311
- message: 'Metric is missing required "type" field',
312
- severity: 'error',
313
- suggestion: `Valid types: ${VALID_METRIC_TYPES.join(', ')}`,
314
- });
315
- } else if (!VALID_METRIC_TYPES.includes(m.type as MetricType)) {
316
- errors.push({
317
- path: `${metricPath}.type`,
318
- message: `Invalid metric type: "${m.type}"`,
319
- severity: 'error',
320
- suggestion: `Valid types: ${VALID_METRIC_TYPES.join(', ')}`,
321
- });
322
- }
323
-
324
- // Required: sources
325
- if (!m.sources) {
326
- errors.push({
327
- path: `${metricPath}.sources`,
328
- message: 'Metric is missing required "sources" array',
329
- severity: 'error',
330
- suggestion: 'Add at least one source linking to a storyboard/workflow',
331
- });
332
- } else if (!Array.isArray(m.sources)) {
333
- errors.push({
334
- path: `${metricPath}.sources`,
335
- message: 'Metric "sources" must be an array',
336
- severity: 'error',
337
- });
338
- } else if (m.sources.length === 0) {
339
- errors.push({
340
- path: `${metricPath}.sources`,
341
- message: 'Metric must have at least one source',
342
- severity: 'error',
343
- });
344
- } else {
345
- m.sources.forEach((source, sourceIndex) => {
346
- this.validateSource(source, `${metricPath}.sources[${sourceIndex}]`, errors, warnings, context);
347
- });
348
- }
349
-
350
- // Required: query
351
- if (!m.query) {
352
- errors.push({
353
- path: `${metricPath}.query`,
354
- message: 'Metric is missing required "query" object',
355
- severity: 'error',
356
- });
357
- } else if (typeof m.query !== 'object' || Array.isArray(m.query)) {
358
- errors.push({
359
- path: `${metricPath}.query`,
360
- message: 'Metric "query" must be an object',
361
- severity: 'error',
362
- });
363
- } else {
364
- this.validateQuery(m.query, `${metricPath}.query`, errors, warnings);
365
- }
366
-
367
- // Optional: thresholds
368
- if (m.thresholds !== undefined) {
369
- if (typeof m.thresholds !== 'object' || Array.isArray(m.thresholds)) {
370
- errors.push({
371
- path: `${metricPath}.thresholds`,
372
- message: '"thresholds" must be an object',
373
- severity: 'error',
374
- });
375
- } else {
376
- if (m.thresholds.warning !== undefined && typeof m.thresholds.warning !== 'number') {
377
- errors.push({
378
- path: `${metricPath}.thresholds.warning`,
379
- message: 'Threshold "warning" must be a number',
380
- severity: 'error',
381
- });
382
- }
383
- if (m.thresholds.critical !== undefined && typeof m.thresholds.critical !== 'number') {
384
- errors.push({
385
- path: `${metricPath}.thresholds.critical`,
386
- message: 'Threshold "critical" must be a number',
387
- severity: 'error',
388
- });
389
- }
390
- }
391
- }
392
-
393
- // Optional: display
394
- if (m.display !== undefined) {
395
- this.validateDisplay(m.display, `${metricPath}.display`, errors, warnings);
396
- }
397
-
398
- // Check for _mockData (informational)
399
- if (!m._mockData) {
400
- warnings.push({
401
- path: `${metricPath}._mockData`,
402
- message: 'No mock data provided for prototyping',
403
- severity: 'warning',
404
- suggestion: 'Add _mockData to prototype the dashboard before live OTEL data',
405
- });
406
- }
407
- }
408
-
409
- /**
410
- * Validate a metric source
411
- */
412
- private validateSource(
413
- source: unknown,
414
- path: string,
415
- errors: DashboardValidationError[],
416
- warnings: DashboardValidationError[],
417
- context?: DashboardValidationContext
418
- ): void {
419
- if (!source || typeof source !== 'object') {
420
- errors.push({
421
- path,
422
- message: 'Source must be an object',
423
- severity: 'error',
424
- });
425
- return;
426
- }
427
-
428
- const s = source as Partial<MetricSource>;
429
-
430
- // Required: storyboard
431
- if (!s.storyboard) {
432
- errors.push({
433
- path: `${path}.storyboard`,
434
- message: 'Source is missing required "storyboard" field',
435
- severity: 'error',
436
- });
437
- } else if (typeof s.storyboard !== 'string') {
438
- errors.push({
439
- path: `${path}.storyboard`,
440
- message: 'Source "storyboard" must be a string',
441
- severity: 'error',
442
- });
443
- } else if (context?.storyboards && !context.storyboards.includes(s.storyboard)) {
444
- errors.push({
445
- path: `${path}.storyboard`,
446
- message: `Unknown storyboard: "${s.storyboard}"`,
447
- severity: 'error',
448
- suggestion: `Known storyboards: ${context.storyboards.join(', ')}`,
449
- });
450
- }
451
-
452
- // Required: workflow
453
- if (!s.workflow) {
454
- errors.push({
455
- path: `${path}.workflow`,
456
- message: 'Source is missing required "workflow" field',
457
- severity: 'error',
458
- });
459
- } else if (typeof s.workflow !== 'string') {
460
- errors.push({
461
- path: `${path}.workflow`,
462
- message: 'Source "workflow" must be a string',
463
- severity: 'error',
464
- });
465
- } else if (
466
- context?.workflows &&
467
- s.storyboard &&
468
- context.workflows[s.storyboard] &&
469
- !context.workflows[s.storyboard].includes(s.workflow)
470
- ) {
471
- errors.push({
472
- path: `${path}.workflow`,
473
- message: `Unknown workflow "${s.workflow}" in storyboard "${s.storyboard}"`,
474
- severity: 'error',
475
- suggestion: context.workflows[s.storyboard].length > 0
476
- ? `Known workflows in "${s.storyboard}": ${context.workflows[s.storyboard].join(', ')}`
477
- : `No workflows found in storyboard "${s.storyboard}"`,
478
- });
479
- }
480
-
481
- // Optional: type
482
- if (s.type !== undefined && s.type !== 'event' && s.type !== 'span') {
483
- errors.push({
484
- path: `${path}.type`,
485
- message: 'Source "type" must be "event" or "span"',
486
- severity: 'error',
487
- });
488
- }
489
-
490
- // Optional: nodes
491
- if (s.nodes !== undefined) {
492
- if (!Array.isArray(s.nodes)) {
493
- errors.push({
494
- path: `${path}.nodes`,
495
- message: 'Source "nodes" must be an array of strings',
496
- severity: 'error',
497
- });
498
- } else {
499
- s.nodes.forEach((node, i) => {
500
- if (typeof node !== 'string') {
501
- errors.push({
502
- path: `${path}.nodes[${i}]`,
503
- message: 'Node must be a string',
504
- severity: 'error',
505
- });
506
- }
507
- });
508
- }
509
- }
510
-
511
- // Optional: event
512
- if (s.event !== undefined && typeof s.event !== 'string') {
513
- errors.push({
514
- path: `${path}.event`,
515
- message: 'Source "event" must be a string',
516
- severity: 'error',
517
- });
518
- }
519
- }
520
-
521
- /**
522
- * Validate a metric query
523
- */
524
- private validateQuery(
525
- query: unknown,
526
- path: string,
527
- errors: DashboardValidationError[],
528
- warnings: DashboardValidationError[]
529
- ): void {
530
- const q = query as Partial<MetricQuery>;
531
-
532
- // Required: derivation
533
- if (!q.derivation) {
534
- errors.push({
535
- path: `${path}.derivation`,
536
- message: 'Query is missing required "derivation" field',
537
- severity: 'error',
538
- suggestion: `Valid derivations: ${VALID_DERIVATIONS.join(', ')}`,
539
- });
540
- } else if (!VALID_DERIVATIONS.includes(q.derivation as Derivation)) {
541
- errors.push({
542
- path: `${path}.derivation`,
543
- message: `Invalid derivation: "${q.derivation}"`,
544
- severity: 'error',
545
- suggestion: `Valid derivations: ${VALID_DERIVATIONS.join(', ')}`,
546
- });
547
- }
548
-
549
- // Optional: timeGroup
550
- if (q.timeGroup !== undefined && !VALID_TIME_GROUPS.includes(q.timeGroup as TimeGroup)) {
551
- errors.push({
552
- path: `${path}.timeGroup`,
553
- message: `Invalid timeGroup: "${q.timeGroup}"`,
554
- severity: 'error',
555
- suggestion: `Valid time groups: ${VALID_TIME_GROUPS.join(', ')}`,
556
- });
557
- }
558
-
559
- // Optional: groupBy
560
- if (q.groupBy !== undefined) {
561
- if (!Array.isArray(q.groupBy)) {
562
- errors.push({
563
- path: `${path}.groupBy`,
564
- message: '"groupBy" must be an array of strings',
565
- severity: 'error',
566
- });
567
- } else {
568
- q.groupBy.forEach((field, i) => {
569
- if (typeof field !== 'string') {
570
- errors.push({
571
- path: `${path}.groupBy[${i}]`,
572
- message: 'groupBy field must be a string',
573
- severity: 'error',
574
- });
575
- }
576
- });
577
- }
578
- }
579
-
580
- // Optional: window
581
- if (q.window !== undefined && typeof q.window !== 'string') {
582
- errors.push({
583
- path: `${path}.window`,
584
- message: '"window" must be a string (e.g., "1h", "24h")',
585
- severity: 'error',
586
- });
587
- }
588
- }
589
-
590
- /**
591
- * Validate metric display options
592
- */
593
- private validateDisplay(
594
- display: unknown,
595
- path: string,
596
- errors: DashboardValidationError[],
597
- warnings: DashboardValidationError[]
598
- ): void {
599
- if (typeof display !== 'object' || Array.isArray(display)) {
600
- errors.push({
601
- path,
602
- message: '"display" must be an object',
603
- severity: 'error',
604
- });
605
- return;
606
- }
607
-
608
- const d = display as Partial<MetricDisplay>;
609
-
610
- // Optional: component
611
- if (d.component !== undefined && !VALID_DISPLAY_COMPONENTS.includes(d.component as DisplayComponent)) {
612
- errors.push({
613
- path: `${path}.component`,
614
- message: `Invalid display component: "${d.component}"`,
615
- severity: 'error',
616
- suggestion: `Valid components: ${VALID_DISPLAY_COMPONENTS.join(', ')}`,
617
- });
618
- }
619
-
620
- // Optional: size
621
- if (d.size !== undefined && !['small', 'medium', 'large'].includes(d.size)) {
622
- errors.push({
623
- path: `${path}.size`,
624
- message: `Invalid size: "${d.size}"`,
625
- severity: 'error',
626
- suggestion: 'Valid sizes: small, medium, large',
627
- });
628
- }
629
- }
630
-
631
- /**
632
- * Validate dashboard layout
633
- */
634
- private validateLayout(
635
- layout: unknown,
636
- errors: DashboardValidationError[],
637
- warnings: DashboardValidationError[],
638
- metricIds: Set<string>
639
- ): void {
640
- const l = layout as Partial<DashboardLayout>;
641
-
642
- // Optional: columns
643
- if (l.columns !== undefined) {
644
- if (typeof l.columns !== 'number' || l.columns < 1) {
645
- errors.push({
646
- path: 'layout.columns',
647
- message: '"columns" must be a positive number',
648
- severity: 'error',
649
- });
650
- }
651
- }
652
-
653
- // Required: rows
654
- if (!l.rows) {
655
- errors.push({
656
- path: 'layout.rows',
657
- message: 'Layout is missing required "rows" array',
658
- severity: 'error',
659
- });
660
- } else if (!Array.isArray(l.rows)) {
661
- errors.push({
662
- path: 'layout.rows',
663
- message: '"rows" must be an array',
664
- severity: 'error',
665
- });
666
- } else if (l.rows.length === 0) {
667
- warnings.push({
668
- path: 'layout.rows',
669
- message: 'Layout has no rows defined',
670
- severity: 'warning',
671
- });
672
- } else {
673
- const referencedMetricIds = new Set<string>();
674
-
675
- l.rows.forEach((row, rowIndex) => {
676
- this.validateRow(row, rowIndex, errors, warnings, metricIds, referencedMetricIds);
677
- });
678
-
679
- // Check for orphaned metrics (defined but not in layout)
680
- metricIds.forEach((id) => {
681
- if (!referencedMetricIds.has(id)) {
682
- warnings.push({
683
- path: `layout`,
684
- message: `Metric "${id}" is defined but not placed in any layout row`,
685
- severity: 'warning',
686
- suggestion: 'Add a panel referencing this metric or remove the metric definition',
687
- });
688
- }
689
- });
690
- }
691
- }
692
-
693
- /**
694
- * Validate a layout row
695
- */
696
- private validateRow(
697
- row: unknown,
698
- rowIndex: number,
699
- errors: DashboardValidationError[],
700
- warnings: DashboardValidationError[],
701
- metricIds: Set<string>,
702
- referencedMetricIds: Set<string>
703
- ): void {
704
- const rowPath = `layout.rows[${rowIndex}]`;
705
-
706
- if (!row || typeof row !== 'object') {
707
- errors.push({
708
- path: rowPath,
709
- message: 'Row must be an object',
710
- severity: 'error',
711
- });
712
- return;
713
- }
714
-
715
- const r = row as Partial<DashboardRow>;
716
-
717
- // Optional: title
718
- if (r.title !== undefined && typeof r.title !== 'string') {
719
- errors.push({
720
- path: `${rowPath}.title`,
721
- message: 'Row "title" must be a string',
722
- severity: 'error',
723
- });
724
- }
725
-
726
- // Required: panels
727
- if (!r.panels) {
728
- errors.push({
729
- path: `${rowPath}.panels`,
730
- message: 'Row is missing required "panels" array',
731
- severity: 'error',
732
- });
733
- } else if (!Array.isArray(r.panels)) {
734
- errors.push({
735
- path: `${rowPath}.panels`,
736
- message: '"panels" must be an array',
737
- severity: 'error',
738
- });
739
- } else if (r.panels.length === 0) {
740
- warnings.push({
741
- path: `${rowPath}.panels`,
742
- message: 'Row has no panels',
743
- severity: 'warning',
744
- });
745
- } else {
746
- r.panels.forEach((panel, panelIndex) => {
747
- this.validatePanel(panel, `${rowPath}.panels[${panelIndex}]`, errors, warnings, metricIds, referencedMetricIds);
748
- });
749
- }
750
- }
751
-
752
- /**
753
- * Validate a panel placement
754
- */
755
- private validatePanel(
756
- panel: unknown,
757
- path: string,
758
- errors: DashboardValidationError[],
759
- warnings: DashboardValidationError[],
760
- metricIds: Set<string>,
761
- referencedMetricIds: Set<string>
762
- ): void {
763
- if (!panel || typeof panel !== 'object') {
764
- errors.push({
765
- path,
766
- message: 'Panel must be an object',
767
- severity: 'error',
768
- });
769
- return;
770
- }
771
-
772
- const p = panel as Partial<PanelPlacement>;
773
-
774
- // Required: id
775
- if (!p.id) {
776
- errors.push({
777
- path: `${path}.id`,
778
- message: 'Panel is missing required "id" field',
779
- severity: 'error',
780
- suggestion: 'Reference a metric ID defined in the metrics array',
781
- });
782
- } else if (typeof p.id !== 'string') {
783
- errors.push({
784
- path: `${path}.id`,
785
- message: 'Panel "id" must be a string',
786
- severity: 'error',
787
- });
788
- } else {
789
- referencedMetricIds.add(p.id);
790
-
791
- if (!metricIds.has(p.id)) {
792
- errors.push({
793
- path: `${path}.id`,
794
- message: `Panel references unknown metric: "${p.id}"`,
795
- severity: 'error',
796
- suggestion: `Available metrics: ${Array.from(metricIds).join(', ') || '(none defined)'}`,
797
- });
798
- }
799
- }
800
-
801
- // Optional: span
802
- if (p.span !== undefined) {
803
- if (typeof p.span !== 'number' || p.span < 1) {
804
- errors.push({
805
- path: `${path}.span`,
806
- message: '"span" must be a positive number',
807
- severity: 'error',
808
- });
809
- }
810
- }
811
-
812
- // Optional: spanMobile
813
- if (p.spanMobile !== undefined) {
814
- if (typeof p.spanMobile !== 'number' || p.spanMobile < 1) {
815
- errors.push({
816
- path: `${path}.spanMobile`,
817
- message: '"spanMobile" must be a positive number',
818
- severity: 'error',
819
- });
820
- }
821
- } else if (p.span !== undefined) {
822
- warnings.push({
823
- path: `${path}`,
824
- message: 'Panel has span but no spanMobile for responsive layout',
825
- severity: 'warning',
826
- suggestion: 'Add spanMobile: 12 for full-width on mobile',
827
- });
828
- }
829
-
830
- // Optional: minHeight
831
- if (p.minHeight !== undefined && typeof p.minHeight !== 'number') {
832
- errors.push({
833
- path: `${path}.minHeight`,
834
- message: '"minHeight" must be a number',
835
- severity: 'error',
836
- });
837
- }
838
- }
839
-
840
- /**
841
- * Validate and throw if invalid
842
- */
843
- validateOrThrow(
844
- data: unknown,
845
- filePath?: string,
846
- context?: DashboardValidationContext
847
- ): DashboardDefinition {
848
- const result = this.validate(data, filePath, context);
849
-
850
- if (!result.valid) {
851
- const errorMessages = result.errors.map(
852
- (e) => `${e.path}: ${e.message}${e.suggestion ? ` (${e.suggestion})` : ''}`
853
- );
854
- throw new Error(`Invalid dashboard data:\n${errorMessages.join('\n')}`);
855
- }
856
-
857
- return data as DashboardDefinition;
858
- }
859
-
860
- /**
861
- * Format validation result as human-readable report
862
- */
863
- formatReport(result: DashboardValidationResult): string {
864
- const lines: string[] = [];
865
-
866
- if (result.valid && result.warnings.length === 0) {
867
- lines.push('✓ Dashboard definition is valid');
868
- return lines.join('\n');
869
- }
870
-
871
- if (result.errors.length > 0) {
872
- lines.push('Validation errors:\n');
873
- result.errors.forEach((error) => {
874
- lines.push(` ${error.path}`);
875
- lines.push(` ${error.message}`);
876
- if (error.suggestion) {
877
- lines.push(` → ${error.suggestion}`);
878
- }
879
- lines.push('');
880
- });
881
- }
882
-
883
- if (result.warnings.length > 0) {
884
- lines.push('Warnings:\n');
885
- result.warnings.forEach((warning) => {
886
- lines.push(` ${warning.path}`);
887
- lines.push(` ${warning.message}`);
888
- if (warning.suggestion) {
889
- lines.push(` → ${warning.suggestion}`);
890
- }
891
- lines.push('');
892
- });
893
- }
894
-
895
- return lines.join('\n');
896
- }
897
- }
898
-
899
- /**
900
- * Create a new dashboard validator instance
901
- */
902
- export function createDashboardValidator(): DashboardValidator {
903
- return new DashboardValidator();
904
- }