Feat/organise by suite (#6)

Ma11hewThomas · web-flow · commit e91c6c9c3045 · 2025-10-10T20:45:42.000+01:00
* feat: add organizeTestsBySuite

* docs: update function definitions and add Baseline interface documentation
diff --git a/docs/README.md b/docs/README.md
@@ -4,35 +4,24 @@
 
 # CTRF v0.0.16
 
-## Enumerations
-
-- [SortOrder](enumerations/SortOrder.md)
-
-## Interfaces
+## Schema
 
 - [Attachment](interfaces/Attachment.md)
+- [Baseline](interfaces/Baseline.md)
 - [Environment](interfaces/Environment.md)
-- [Insights](interfaces/Insights.md)
 - [InsightsMetric](interfaces/InsightsMetric.md)
 - [Report](interfaces/Report.md)
 - [Results](interfaces/Results.md)
 - [RetryAttempt](interfaces/RetryAttempt.md)
+- [RootInsights](interfaces/RootInsights.md)
 - [Step](interfaces/Step.md)
 - [Summary](interfaces/Summary.md)
 - [Test](interfaces/Test.md)
 - [TestInsights](interfaces/TestInsights.md)
-- [TestTree](interfaces/TestTree.md)
 - [Tool](interfaces/Tool.md)
-- [TreeNode](interfaces/TreeNode.md)
-- [TreeOptions](interfaces/TreeOptions.md)
-- [ValidationResult](interfaces/ValidationResult.md)
-
-## Type Aliases
-
 - [TestStatus](type-aliases/TestStatus.md)
-- [TreeTest](type-aliases/TreeTest.md)
 
-## Functions
+## Methods
 
 - [enrichReportWithInsights](functions/enrichReportWithInsights.md)
 - [findSuiteByName](functions/findSuiteByName.md)
@@ -51,3 +40,18 @@
 - [traverseTree](functions/traverseTree.md)
 - [validateReport](functions/validateReport.md)
 - [validateReportStrict](functions/validateReportStrict.md)
+
+## Enumerations
+
+- [SortOrder](enumerations/SortOrder.md)
+
+## Interfaces
+
+- [TestTree](interfaces/TestTree.md)
+- [TreeNode](interfaces/TreeNode.md)
+- [TreeOptions](interfaces/TreeOptions.md)
+- [ValidationResult](interfaces/ValidationResult.md)
+
+## Type Aliases
+
+- [TreeTest](type-aliases/TreeTest.md)
diff --git a/docs/functions/findSuiteByName.md b/docs/functions/findSuiteByName.md
@@ -8,7 +8,7 @@
 
 > **findSuiteByName**(`nodes`, `name`): `undefined` \| [`TreeNode`](../interfaces/TreeNode.md)
 
-Defined in: src/methods/tree-hierarchical-structure.ts:331
+Defined in: [src/methods/tree-hierarchical-structure.ts:331](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L331)
 
 Utility function to find a suite by name in the tree
 
diff --git a/docs/functions/findTestByName.md b/docs/functions/findTestByName.md
@@ -8,7 +8,7 @@
 
 > **findTestByName**(`nodes`, `name`): `undefined` \| [`TreeTest`](../type-aliases/TreeTest.md)
 
-Defined in: src/methods/tree-hierarchical-structure.ts:354
+Defined in: [src/methods/tree-hierarchical-structure.ts:354](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L354)
 
 Utility function to find a test by name in the tree
 
diff --git a/docs/functions/flattenTree.md b/docs/functions/flattenTree.md
@@ -8,7 +8,7 @@
 
 > **flattenTree**(`nodes`): `object`[]
 
-Defined in: src/methods/tree-hierarchical-structure.ts:379
+Defined in: [src/methods/tree-hierarchical-structure.ts:379](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L379)
 
 Utility function to convert tree to a flat array with indentation information
 Useful for displaying the tree in a linear format
diff --git a/docs/functions/getAllTests.md b/docs/functions/getAllTests.md
@@ -8,7 +8,7 @@
 
 > **getAllTests**(`nodes`): [`TreeTest`](../type-aliases/TreeTest.md)[]
 
-Defined in: src/methods/tree-hierarchical-structure.ts:403
+Defined in: [src/methods/tree-hierarchical-structure.ts:403](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L403)
 
 Utility function to get all tests from the tree structure as a flat array
 
diff --git a/docs/functions/getSuiteStats.md b/docs/functions/getSuiteStats.md
@@ -8,7 +8,7 @@
 
 > **getSuiteStats**(`nodes`, `suitePath`): `undefined` \| [`Summary`](../interfaces/Summary.md)
 
-Defined in: src/methods/tree-hierarchical-structure.ts:422
+Defined in: [src/methods/tree-hierarchical-structure.ts:422](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L422)
 
 Utility function to get statistics for a specific suite path
 
diff --git a/docs/functions/organizeTestsBySuite.md b/docs/functions/organizeTestsBySuite.md
@@ -8,7 +8,7 @@
 
 > **organizeTestsBySuite**(`tests`, `options`): [`TestTree`](../interfaces/TestTree.md)
 
-Defined in: src/methods/tree-hierarchical-structure.ts:92
+Defined in: [src/methods/tree-hierarchical-structure.ts:92](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L92)
 
 Organizes CTRF tests into a hierarchical tree structure based on the suite property.
 
diff --git a/docs/functions/traverseTree.md b/docs/functions/traverseTree.md
@@ -8,7 +8,7 @@
 
 > **traverseTree**(`nodes`, `callback`, `depth`): `void`
 
-Defined in: src/methods/tree-hierarchical-structure.ts:302
+Defined in: [src/methods/tree-hierarchical-structure.ts:302](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L302)
 
 Utility function to traverse the tree and apply a function to each node
 
diff --git a/docs/interfaces/Baseline.md b/docs/interfaces/Baseline.md
@@ -0,0 +1,73 @@
+[**CTRF v0.0.16**](../README.md)
+
+***
+
+[CTRF](../README.md) / Baseline
+
+# Interface: Baseline
+
+Defined in: [types/ctrf.d.ts:150](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L150)
+
+## Properties
+
+### buildName?
+
+> `optional` **buildName**: `string`
+
+Defined in: [types/ctrf.d.ts:155](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L155)
+
+***
+
+### buildNumber?
+
+> `optional` **buildNumber**: `number`
+
+Defined in: [types/ctrf.d.ts:156](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L156)
+
+***
+
+### buildUrl?
+
+> `optional` **buildUrl**: `string`
+
+Defined in: [types/ctrf.d.ts:157](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L157)
+
+***
+
+### commit?
+
+> `optional` **commit**: `string`
+
+Defined in: [types/ctrf.d.ts:154](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L154)
+
+***
+
+### extra?
+
+> `optional` **extra**: `Record`\<`string`, `unknown`\>
+
+Defined in: [types/ctrf.d.ts:158](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L158)
+
+***
+
+### reportId
+
+> **reportId**: `string`
+
+Defined in: [types/ctrf.d.ts:151](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L151)
+
+***
+
+### source?
+
+> `optional` **source**: `string`
+
+Defined in: [types/ctrf.d.ts:152](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L152)
+
+***
+
+### timestamp?
+
+> `optional` **timestamp**: `string`
+
+Defined in: [types/ctrf.d.ts:153](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L153)
diff --git a/docs/interfaces/Report.md b/docs/interfaces/Report.md
@@ -12,7 +12,7 @@ Defined in: [types/ctrf.d.ts:1](https://github.com/ctrf-io/ctrf-core-js/blob/mai
 
 ### baseline?
 
-> `optional` **baseline**: `Baseline`
+> `optional` **baseline**: [`Baseline`](Baseline.md)
 
 Defined in: [types/ctrf.d.ts:9](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L9)
 
@@ -36,7 +36,7 @@ Defined in: [types/ctrf.d.ts:6](https://github.com/ctrf-io/ctrf-core-js/blob/mai
 
 ### insights?
 
-> `optional` **insights**: [`Insights`](Insights.md)
+> `optional` **insights**: [`RootInsights`](RootInsights.md)
 
 Defined in: [types/ctrf.d.ts:8](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L8)
 
diff --git a/docs/interfaces/RootInsights.md b/docs/interfaces/RootInsights.md
@@ -2,9 +2,9 @@
 
 ***
 
-[CTRF](../README.md) / Insights
+[CTRF](../README.md) / RootInsights
 
-# Interface: Insights
+# Interface: RootInsights
 
 Defined in: [types/ctrf.d.ts:123](https://github.com/ctrf-io/ctrf-core-js/blob/main/types/ctrf.d.ts#L123)
 
diff --git a/docs/interfaces/TestTree.md b/docs/interfaces/TestTree.md
@@ -6,7 +6,7 @@
 
 # Interface: TestTree
 
-Defined in: src/methods/tree-hierarchical-structure.ts:44
+Defined in: [src/methods/tree-hierarchical-structure.ts:44](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L44)
 
 Result of converting tests to tree structure
 
@@ -16,7 +16,7 @@ Result of converting tests to tree structure
 
 > **roots**: [`TreeNode`](TreeNode.md)[]
 
-Defined in: src/methods/tree-hierarchical-structure.ts:46
+Defined in: [src/methods/tree-hierarchical-structure.ts:46](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L46)
 
 Root nodes of the tree (top-level suites)
 
@@ -26,6 +26,6 @@ Root nodes of the tree (top-level suites)
 
 > `optional` **summary**: [`Summary`](Summary.md)
 
-Defined in: src/methods/tree-hierarchical-structure.ts:48
+Defined in: [src/methods/tree-hierarchical-structure.ts:48](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L48)
 
 Overall statistics for all tests (only present when includeSummary is true)
diff --git a/docs/interfaces/TreeNode.md b/docs/interfaces/TreeNode.md
@@ -6,7 +6,7 @@
 
 # Interface: TreeNode
 
-Defined in: src/methods/tree-hierarchical-structure.ts:16
+Defined in: [src/methods/tree-hierarchical-structure.ts:16](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L16)
 
 Represents a tree node (suite) that can contain tests and child suites
 Following the CTRF Suite Tree schema specification
@@ -17,7 +17,7 @@ Following the CTRF Suite Tree schema specification
 
 > **duration**: `number`
 
-Defined in: src/methods/tree-hierarchical-structure.ts:22
+Defined in: [src/methods/tree-hierarchical-structure.ts:22](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L22)
 
 Total duration of all tests in this suite and children
 
@@ -27,7 +27,7 @@ Total duration of all tests in this suite and children
 
 > `optional` **extra**: `Record`\<`string`, `unknown`\>
 
-Defined in: src/methods/tree-hierarchical-structure.ts:30
+Defined in: [src/methods/tree-hierarchical-structure.ts:30](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L30)
 
 Additional properties
 
@@ -37,7 +37,7 @@ Additional properties
 
 > **name**: `string`
 
-Defined in: src/methods/tree-hierarchical-structure.ts:18
+Defined in: [src/methods/tree-hierarchical-structure.ts:18](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L18)
 
 The name of this suite
 
@@ -47,7 +47,7 @@ The name of this suite
 
 > **status**: [`TestStatus`](../type-aliases/TestStatus.md)
 
-Defined in: src/methods/tree-hierarchical-structure.ts:20
+Defined in: [src/methods/tree-hierarchical-structure.ts:20](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L20)
 
 The status of this suite (derived from child test results)
 
@@ -57,7 +57,7 @@ The status of this suite (derived from child test results)
 
 > **suites**: `TreeNode`[]
 
-Defined in: src/methods/tree-hierarchical-structure.ts:28
+Defined in: [src/methods/tree-hierarchical-structure.ts:28](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L28)
 
 Child suites contained within this suite
 
@@ -67,7 +67,7 @@ Child suites contained within this suite
 
 > `optional` **summary**: [`Summary`](Summary.md)
 
-Defined in: src/methods/tree-hierarchical-structure.ts:24
+Defined in: [src/methods/tree-hierarchical-structure.ts:24](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L24)
 
 Aggregated statistics for this suite (only present when includeSummary is true)
 
@@ -77,6 +77,6 @@ Aggregated statistics for this suite (only present when includeSummary is true)
 
 > **tests**: [`TreeTest`](../type-aliases/TreeTest.md)[]
 
-Defined in: src/methods/tree-hierarchical-structure.ts:26
+Defined in: [src/methods/tree-hierarchical-structure.ts:26](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L26)
 
 Tests directly contained in this suite
diff --git a/docs/interfaces/TreeOptions.md b/docs/interfaces/TreeOptions.md
@@ -6,7 +6,7 @@
 
 # Interface: TreeOptions
 
-Defined in: src/methods/tree-hierarchical-structure.ts:36
+Defined in: [src/methods/tree-hierarchical-structure.ts:36](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L36)
 
 Options for controlling tree structure creation
 
@@ -16,6 +16,6 @@ Options for controlling tree structure creation
 
 > `optional` **includeSummary**: `boolean`
 
-Defined in: src/methods/tree-hierarchical-structure.ts:38
+Defined in: [src/methods/tree-hierarchical-structure.ts:38](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L38)
 
 Whether to include summary statistics aggregation (default: true)
diff --git a/docs/type-aliases/TreeTest.md b/docs/type-aliases/TreeTest.md
@@ -8,7 +8,7 @@
 
 > **TreeTest** = [`Test`](../interfaces/Test.md) & `object`
 
-Defined in: src/methods/tree-hierarchical-structure.ts:7
+Defined in: [src/methods/tree-hierarchical-structure.ts:7](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/tree-hierarchical-structure.ts#L7)
 
 Tree test extends CTRF Test with a nodeType field for tree traversal
 
diff --git a/src/index.ts b/src/index.ts
diff --git a/src/methods/run-insights.ts b/src/methods/run-insights.ts
diff --git a/typedoc.json b/typedoc.json
diff --git a/types/ctrf.d.ts b/types/ctrf.d.ts
