@epilot/app-client 0.12.6 → 0.12.7
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/dist/openapi.d.ts +10 -0
- package/dist/openapi.json +1 -1
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -1520,9 +1520,14 @@ declare namespace Components {
|
|
|
1520
1520
|
* - 200 with a JSON body of shape:
|
|
1521
1521
|
* {
|
|
1522
1522
|
* "type_options": [{ "id": "ht", "label": { "en": "High tariff" }, "aggregation_group": "consumption", "unit": "kWh" }, ...],
|
|
1523
|
+
* "statistical_method": "sum",
|
|
1523
1524
|
* "intervals": ["PT15M", "PT1H", "P1D", "P1M"],
|
|
1524
1525
|
* "data_range": { "from": "2024-01-01T00:00:00Z", "to": "2026-05-01T00:00:00Z" }
|
|
1525
1526
|
* }
|
|
1527
|
+
* `statistical_method` describes the statistical method already applied to the data the data hook returns and dictates the chart shape: `sum` is rendered as a bar chart; `min`, `average`, and `max` are rendered as a line chart. Defaults to `sum` when omitted.
|
|
1528
|
+
* `aggregation_group` controls how types within a group are visually combined:
|
|
1529
|
+
* - bar chart (`sum`): same-group types are stacked into a single bar (e.g. ht/nt summed into total consumption); different-group types render side-by-side.
|
|
1530
|
+
* - line chart (`min` / `average` / `max`): same-group types are rendered as an area chart; different-group types render as separate lines.
|
|
1526
1531
|
* All fields are optional; the consumer falls back to its defaults for whatever the hook does not return.
|
|
1527
1532
|
* The portal looks up this hook implicitly per extension (one `visualizationMetadata` hook per extension) — there is no need for a data-retrieval hook to reference it explicitly.
|
|
1528
1533
|
*
|
|
@@ -2036,9 +2041,14 @@ declare namespace Components {
|
|
|
2036
2041
|
* - 200 with a JSON body of shape:
|
|
2037
2042
|
* {
|
|
2038
2043
|
* "type_options": [{ "id": "ht", "label": { "en": "High tariff" }, "aggregation_group": "consumption", "unit": "kWh" }, ...],
|
|
2044
|
+
* "statistical_method": "sum",
|
|
2039
2045
|
* "intervals": ["PT15M", "PT1H", "P1D", "P1M"],
|
|
2040
2046
|
* "data_range": { "from": "2024-01-01T00:00:00Z", "to": "2026-05-01T00:00:00Z" }
|
|
2041
2047
|
* }
|
|
2048
|
+
* `statistical_method` describes the statistical method already applied to the data the data hook returns and dictates the chart shape: `sum` is rendered as a bar chart; `min`, `average`, and `max` are rendered as a line chart. Defaults to `sum` when omitted.
|
|
2049
|
+
* `aggregation_group` controls how types within a group are visually combined:
|
|
2050
|
+
* - bar chart (`sum`): same-group types are stacked into a single bar (e.g. ht/nt summed into total consumption); different-group types render side-by-side.
|
|
2051
|
+
* - line chart (`min` / `average` / `max`): same-group types are rendered as an area chart; different-group types render as separate lines.
|
|
2042
2052
|
* All fields are optional; the consumer falls back to its defaults for whatever the hook does not return.
|
|
2043
2053
|
* The portal looks up this hook implicitly per extension (one `visualizationMetadata` hook per extension) — there is no need for a data-retrieval hook to reference it explicitly.
|
|
2044
2054
|
*
|
package/dist/openapi.json
CHANGED
|
@@ -3252,7 +3252,7 @@
|
|
|
3252
3252
|
"additionalProperties": false
|
|
3253
3253
|
},
|
|
3254
3254
|
"PortalExtensionHookVisualizationMetadata": {
|
|
3255
|
-
"description": "Hook that returns runtime metadata describing how a visualization (consumption / price / cost chart) should be rendered for a given portal context (meter, contract, etc). It is invoked by the portal before fetching data, with the same context the data hook would receive, so that the discovery shape can vary per meter/contract. The expected response to the call is:\n - 200 with a JSON body of shape:\n {\n \"type_options\": [{ \"id\": \"ht\", \"label\": { \"en\": \"High tariff\" }, \"aggregation_group\": \"consumption\", \"unit\": \"kWh\" }, ...],\n \"intervals\": [\"PT15M\", \"PT1H\", \"P1D\", \"P1M\"],\n \"data_range\": { \"from\": \"2024-01-01T00:00:00Z\", \"to\": \"2026-05-01T00:00:00Z\" }\n }\n All fields are optional; the consumer falls back to its defaults for whatever the hook does not return.\nThe portal looks up this hook implicitly per extension (one `visualizationMetadata` hook per extension) — there is no need for a data-retrieval hook to reference it explicitly.\n",
|
|
3255
|
+
"description": "Hook that returns runtime metadata describing how a visualization (consumption / price / cost chart) should be rendered for a given portal context (meter, contract, etc). It is invoked by the portal before fetching data, with the same context the data hook would receive, so that the discovery shape can vary per meter/contract. The expected response to the call is:\n - 200 with a JSON body of shape:\n {\n \"type_options\": [{ \"id\": \"ht\", \"label\": { \"en\": \"High tariff\" }, \"aggregation_group\": \"consumption\", \"unit\": \"kWh\" }, ...],\n \"statistical_method\": \"sum\",\n \"intervals\": [\"PT15M\", \"PT1H\", \"P1D\", \"P1M\"],\n \"data_range\": { \"from\": \"2024-01-01T00:00:00Z\", \"to\": \"2026-05-01T00:00:00Z\" }\n }\n `statistical_method` describes the statistical method already applied to the data the data hook returns and dictates the chart shape: `sum` is rendered as a bar chart; `min`, `average`, and `max` are rendered as a line chart. Defaults to `sum` when omitted.\n `aggregation_group` controls how types within a group are visually combined:\n - bar chart (`sum`): same-group types are stacked into a single bar (e.g. ht/nt summed into total consumption); different-group types render side-by-side.\n - line chart (`min` / `average` / `max`): same-group types are rendered as an area chart; different-group types render as separate lines.\n All fields are optional; the consumer falls back to its defaults for whatever the hook does not return.\nThe portal looks up this hook implicitly per extension (one `visualizationMetadata` hook per extension) — there is no need for a data-retrieval hook to reference it explicitly.\n",
|
|
3256
3256
|
"type": "object",
|
|
3257
3257
|
"properties": {
|
|
3258
3258
|
"id": {
|