feat: updating react-dora-charts for compatibility with service-level processing

.releaserc

@@ -5,7 +5,20 @@
   "preset": "conventionalcommits",
   "tagFormat": "v${version}",
   "plugins": [
-    "@semantic-release/commit-analyzer",
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits",
+        "releaseRules": [
+          { "type": "docs", "release": "patch" },
+          { "type": "refactor", "release": "patch" },
+          { "type": "style", "release": "patch" }
+        ],
+        "parserOpts": {
+          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]
+        }
+      }
+    ],
     "@semantic-release/release-notes-generator",
     [
       "@semantic-release/changelog",

CHANGELOG.md

@@ -1,3 +1,13 @@
+## [2.0.0](https://github.com/liatrio/react-dora-charts/compare/v1.1.10...v2.0.0) (2025-04-01)
+
+### ⚠ BREAKING CHANGES
+
+* The component-based API has been replaced with a service-based approach.
+
+### Features
+
+* API to use service instead of component ([#73](https://github.com/liatrio/react-dora-charts/issues/73)) ([638e49a](https://github.com/liatrio/react-dora-charts/commit/638e49a873aa55853cfb1e71f466c8c4e5f2f4a0))
+
 ## [1.1.10](https://github.com/liatrio/react-dora-charts/compare/v1.1.9...v1.1.10) (2025-02-06)
 
 ### Bug Fixes

README.md

@@ -91,15 +91,15 @@ Use this function to create the `data` parameter for the components.
 
 This function takes a (`FetchProps`) object with the following properties.
 
-| Field                           | Required | Description                                                                                                                                                                                                        |
-| ------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `api`                           | true     | This is the url to the API for gathering data.                                                                                                                                                                     |
-| `getAuthHeaderValue`            | false    | This is a function that should provide the value of the `Authorization` HTTP Header for the `api`.<br>If not specified, no auth will be used.                                                                      |
-| `team`                          | false    | The name of the team to show pull data for.                                                                                                                                                                        |
-| `repositories`                  | false    | A list of repository names to pull data for.                                                                                                                                                                       |
-| `daysToPull`                    | false    | The number of days in the past from the current date to pull data for<br>If not specified, 365 is the default.                                                                                                     |
-| `includeWeekendsInCalculations` | false    | When calculating the averages for each metric in the `Board` component, this setting allows you to include/exclude weekends in those calculations.<br>This is useful when you don't have teams that work weekends. |
-| `holidays`                      | false    | This field allows you to specify holidays that your organization follows to exclude from the calculations for the `Board` component.                                                                               |
+| Field                           | Required | Description                                                                                                                                                                                                                 |
+| ------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `api`                           | true     | This is the url to the API for gathering data.                                                                                                                                                                              |
+| `getAuthHeaderValue`            | false    | This is a function that should provide the value of the `Authorization` HTTP Header for the `api`.<br>If not specified, no auth will be used.                                                                               |
+| `service`                       | false    | The name of the service to show pull data for.                                                                                                                                                                              |
+| `repositories`                  | false    | A list of repository names to pull data for.                                                                                                                                                                                |
+| `daysToPull`                    | false    | The number of days in the past from the current date to pull data for<br>If not specified, 365 is the default.                                                                                                              |
+| `includeWeekendsInCalculations` | false    | When calculating the averages for each metric in the `Board` component, this setting allows you to include/exclude weekends in those calculations.<br>This is useful when you don't have services that operate on weekends. |
+| `holidays`                      | false    | This field allows you to specify holidays that your organization follows to exclude from the calculations for the `Board` component.                                                                                        |
 
 ### `buildDoraStateForPeriod`
 
@@ -140,7 +140,7 @@ These functions are just shortcuts to get a Date a certain number of days in the
 | `graphStart`                    |  false   | If not supplied this will default to 30 days in the past.<br>This value is used to determine the starting date for the charts.                                                                                                                                                                                                                                                                                                                                                                                                                        |
 | `graphEnd`                      |  false   | If not supplied, this will default to 1 day in the past.<br>This value is used to determine the ending date for the charts.                                                                                                                                                                                                                                                                                                                                                                                                                           |
 | `loading`                       |  false   | Boolean to allow a container component to control the loading status as it waits to supply `data`.                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
-| `includeWeekendsInCalculations` |  false   | When calculating the averages for each metric, this setting allows you to include/exclude weekends in those calculations.<br>This is useful when you don't have teams that work weekends.                                                                                                                                                                                                                                                                                                                                                             |
+| `includeWeekendsInCalculations` |  false   | When calculating the averages for each metric, this setting allows you to include/exclude weekends in those calculations.<br>This is useful when you don't have services that operate on weekends.                                                                                                                                                                                                                                                                                                                                                    |
 | `metricThresholdSet`            |  false   | This allows you to customize the metric thresholds used for determining the rank of each metric. You only have to override the ones you need. There are defaults based on the official DORA Report that are used when these are not supplied.<br>This takes in a `MetricThresholdSet` object which contains a `MetricThresholds` object for each metric.<br>The threshold values for `elite`, `high` and `medium` are measured in hours. `low` is considered anything longer than medium, so it is not able to be supplied as a value in this object. |
 | `message`                       |  false   | This allows a parent component to display a custom message while it does something. This setting overrides `loading` and the no data state that happens if `data` is empty or the `api` returns no data.                                                                                                                                                                                                                                                                                                                                              |
 | `holidays`                      |  false   | This field allows you to specify holidays that your organization follows to exclude from the calculations for the components.                                                                                                                                                                                                                                                                                                                                                                                                                         |
@@ -184,7 +184,7 @@ The data schema for each chart is as follows:
 {
     records: [{
       repository: string
-      team: string
+      service: string
       title?: string
       user?: string
       sha: string

playwright/helpers/constants.js

@@ -4,7 +4,7 @@ import yaml from 'js-yaml';
 // Constants
 export const BASE_URL = 'http://localhost:6006';
 export const TEMP_DIR = path.resolve(__dirname, '..', 'temp');
-export const DATA_SET_VALUES = ['Low', 'Medium', 'High', 'Elite', 'Team'];
+export const DATA_SET_VALUES = ['Low', 'Medium', 'High', 'Elite', 'Service'];
 
 // Test Parameters
 const yamlFile = path.resolve(__dirname, '..', 'test_parameters.yaml');