@gravitee/gamma-lib-observability 6.7.0 → 6.8.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 (73) hide show
  1. package/INTEGRATION.md +4 -2
  2. package/dist/api-type-registry.d.ts.map +1 -1
  3. package/dist/dashboard-access-provider.js +88 -76
  4. package/dist/dashboards/adapters/time-series-adapter.d.ts +2 -1
  5. package/dist/dashboards/adapters/time-series-adapter.d.ts.map +1 -1
  6. package/dist/dashboards/analytics-table/analytics-table-model.d.ts +9 -4
  7. package/dist/dashboards/analytics-table/analytics-table-model.d.ts.map +1 -1
  8. package/dist/dashboards/editor/DashboardEditorPage.d.ts.map +1 -1
  9. package/dist/dashboards/editor/DimensionSelect.d.ts +2 -1
  10. package/dist/dashboards/editor/DimensionSelect.d.ts.map +1 -1
  11. package/dist/dashboards/editor/FacetQueryFields.d.ts.map +1 -1
  12. package/dist/dashboards/editor/MeasureSelect.d.ts.map +1 -1
  13. package/dist/dashboards/editor/MetricCatalogHint.d.ts +9 -0
  14. package/dist/dashboards/editor/MetricCatalogHint.d.ts.map +1 -0
  15. package/dist/dashboards/editor/MetricGroupItemsEditor.d.ts.map +1 -1
  16. package/dist/dashboards/editor/MetricQueryFields.d.ts.map +1 -1
  17. package/dist/dashboards/editor/MetricSelect.d.ts +3 -2
  18. package/dist/dashboards/editor/MetricSelect.d.ts.map +1 -1
  19. package/dist/dashboards/editor/SeriesListEditor.d.ts.map +1 -1
  20. package/dist/dashboards/editor/TableColumnsEditor.d.ts +2 -1
  21. package/dist/dashboards/editor/TableColumnsEditor.d.ts.map +1 -1
  22. package/dist/dashboards/editor/TableQueryFields.d.ts.map +1 -1
  23. package/dist/dashboards/editor/WidgetConfigForm.d.ts.map +1 -1
  24. package/dist/dashboards/editor/WidgetEditorPanel.d.ts.map +1 -1
  25. package/dist/dashboards/editor/WidgetPreview.d.ts.map +1 -1
  26. package/dist/dashboards/editor/convert-widget-type.d.ts +3 -3
  27. package/dist/dashboards/editor/convert-widget-type.d.ts.map +1 -1
  28. package/dist/dashboards/editor/dashboard-editor-state.d.ts +5 -2
  29. package/dist/dashboards/editor/dashboard-editor-state.d.ts.map +1 -1
  30. package/dist/dashboards/editor/dimension-reset.d.ts +3 -2
  31. package/dist/dashboards/editor/dimension-reset.d.ts.map +1 -1
  32. package/dist/dashboards/editor/locked-filter-conflicts.d.ts +2 -1
  33. package/dist/dashboards/editor/locked-filter-conflicts.d.ts.map +1 -1
  34. package/dist/dashboards/editor/suggest-widget-title.d.ts +2 -1
  35. package/dist/dashboards/editor/suggest-widget-title.d.ts.map +1 -1
  36. package/dist/dashboards/editor/testing/select-options.d.ts +3 -1
  37. package/dist/dashboards/editor/testing/select-options.d.ts.map +1 -1
  38. package/dist/dashboards/editor/widget-auto-scope.d.ts +2 -1
  39. package/dist/dashboards/editor/widget-auto-scope.d.ts.map +1 -1
  40. package/dist/dashboards/metric-catalog.d.ts +101 -46
  41. package/dist/dashboards/metric-catalog.d.ts.map +1 -1
  42. package/dist/dashboards/renderers/CartesianWidgetRenderer.d.ts.map +1 -1
  43. package/dist/dashboards/renderers/MetricGroupWidgetRenderer.d.ts.map +1 -1
  44. package/dist/dashboards/renderers/TableWidgetRenderer.d.ts.map +1 -1
  45. package/dist/data-sources/http-analytics-definition-source.d.ts +59 -0
  46. package/dist/data-sources/http-analytics-definition-source.d.ts.map +1 -0
  47. package/dist/data-sources/http-filter-source.d.ts.map +1 -1
  48. package/dist/data-sources/http-traces-filter-source.d.ts.map +1 -1
  49. package/dist/data-sources/http-utils.d.ts +6 -0
  50. package/dist/data-sources/http-utils.d.ts.map +1 -1
  51. package/dist/hooks/query-keys.d.ts +10 -0
  52. package/dist/hooks/query-keys.d.ts.map +1 -1
  53. package/dist/hooks/use-metric-catalog.d.ts +36 -0
  54. package/dist/hooks/use-metric-catalog.d.ts.map +1 -0
  55. package/dist/index.js +4323 -4205
  56. package/dist/providers/analytics-api-types-provider.d.ts +4 -4
  57. package/dist/providers/analytics-definition-source-provider.d.ts +16 -0
  58. package/dist/providers/analytics-definition-source-provider.d.ts.map +1 -0
  59. package/dist/routing/ObservabilityRoutes.d.ts.map +1 -1
  60. package/dist/routing/resolve-analytics-api-types.d.ts +3 -2
  61. package/dist/routing/resolve-analytics-api-types.d.ts.map +1 -1
  62. package/dist/styles/observability.css +1 -1
  63. package/dist/testing/graphene-charts-mock.d.ts +4 -1
  64. package/dist/testing/graphene-charts-mock.d.ts.map +1 -1
  65. package/dist/testing/graphene-core-icons-mock.d.ts +2 -0
  66. package/dist/testing/graphene-core-icons-mock.d.ts.map +1 -1
  67. package/dist/testing/index.d.ts +6 -0
  68. package/dist/testing/index.d.ts.map +1 -1
  69. package/dist/testing/mock-analytics-definition.d.ts +29 -0
  70. package/dist/testing/mock-analytics-definition.d.ts.map +1 -0
  71. package/dist/testing/mock-metrics-data-source.d.ts.map +1 -1
  72. package/dist/testing.js +42 -39
  73. package/package.json +1 -1
@@ -10,10 +10,10 @@ export interface AnalyticsApiTypesProviderProps {
10
10
  * `resolveAnalyticsApiTypes` read them (an empty list is read as none there,
11
11
  * not here).
12
12
  *
13
- * Mounted once around the editor by `ObservabilityRoutes`, so the metric and
14
- * dimension pickers read it where they render instead of every editor
15
- * threading it through. It is the editor's reading of the host's declaration
16
- * only. The query clamp keeps reading the context filters, and a dashboard
13
+ * Mounted once around every route by `ObservabilityRoutes`, so the metric and
14
+ * dimension pickers read it where they render, and the dashboard view reads
15
+ * its catalog under the same kinds the editor built the widgets on. It is the
16
+ * catalog's reading of the host's declaration only. The query clamp keeps reading the context filters, and a dashboard
17
17
  * filter narrowing `API_TYPE` below the host's types does not narrow the
18
18
  * pickers: `useActiveApiTypes` follows that filter for the filter bar, this
19
19
  * does not.
@@ -0,0 +1,16 @@
1
+ import { ReactNode } from 'react';
2
+ import { AnalyticsDefinitionSource } from '../data-sources/http-analytics-definition-source';
3
+ export interface AnalyticsDefinitionSourceProviderProps {
4
+ readonly source: AnalyticsDefinitionSource;
5
+ readonly children: ReactNode;
6
+ }
7
+ /**
8
+ * Where `useMetricCatalog` reads the analytics definition from. Mounted by
9
+ * `ObservabilityRoutes` with the HTTP source built from `baseUrl`, unless an
10
+ * outer provider (a host's, a test's, a story's) is already there, which then
11
+ * wins, like the metrics data source.
12
+ */
13
+ export declare function AnalyticsDefinitionSourceProvider({ source, children }: AnalyticsDefinitionSourceProviderProps): import("react/jsx-runtime").JSX.Element;
14
+ /** The analytics definition source in scope; undefined when none was mounted, which `useMetricCatalog` reads as "bundled catalog". */
15
+ export declare function useAnalyticsDefinitionSource(): AnalyticsDefinitionSource | undefined;
16
+ //# sourceMappingURL=analytics-definition-source-provider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"analytics-definition-source-provider.d.ts","sourceRoot":"","sources":["../../src/providers/analytics-definition-source-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA6B,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAClE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,kDAAkD,CAAC;AAIlG,MAAM,WAAW,sCAAsC;IACrD,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC;IAC3C,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B;AAED;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,sCAAsC,2CAI7G;AAED,sIAAsI;AACtI,wBAAgB,4BAA4B,IAAI,yBAAyB,GAAG,SAAS,CAEpF"}
@@ -1 +1 @@
1
- {"version":3,"file":"ObservabilityRoutes.d.ts","sourceRoot":"","sources":["../../src/routing/ObservabilityRoutes.tsx"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAoBjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAO9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAS/D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,SAAS,CAAC;AAsD3D,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,eAAe,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;IAC5C,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,cAAc,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IACzC,WAAW,CAAC,EAAE,SAAS,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;IACtD,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IAC1C,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,CAAC;IACxC,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,CAAC;IACxC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,MAAM,EAAE,2BAA2B,CAAC;CACrC;AAyMD,wBAAgB,mBAAmB,CAAC,EAClC,OAAO,EACP,aAAa,EACb,IAAI,EACJ,UAAU,EACV,eAAe,EACf,QAAQ,EACR,cAAc,EACd,WAAW,EACX,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,MAAM,GACP,EAAE,gCAAgC,2CA6WlC"}
1
+ {"version":3,"file":"ObservabilityRoutes.d.ts","sourceRoot":"","sources":["../../src/routing/ObservabilityRoutes.tsx"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAwBjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAO9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAS/D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,SAAS,CAAC;AAsD3D,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,eAAe,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;IAC5C,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,cAAc,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IACzC,WAAW,CAAC,EAAE,SAAS,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;IACtD,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IAC1C,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,CAAC;IACxC,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,CAAC;IACxC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,MAAM,EAAE,2BAA2B,CAAC;CACrC;AAoMD,wBAAgB,mBAAmB,CAAC,EAClC,OAAO,EACP,aAAa,EACb,IAAI,EACJ,UAAU,EACV,eAAe,EACf,QAAQ,EACR,cAAc,EACd,WAAW,EACX,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,MAAM,GACP,EAAE,gCAAgC,2CAwYlC"}
@@ -1,6 +1,7 @@
1
1
  import { DashboardFeatureConfig, ObservabilityFeaturesConfig } from './types';
2
2
  /**
3
- * The API types the widget editor offers its catalog for.
3
+ * The API kinds the metric catalog is asked for, and the widget editor
4
+ * offers it under.
4
5
  *
5
6
  * An explicit `analyticsApiTypes` wins, the dashboards section's over the
6
7
  * global one; an empty list declares none, so a host can keep its queries
@@ -13,7 +14,7 @@ import { DashboardFeatureConfig, ObservabilityFeaturesConfig } from './types';
13
14
  * read as none: the provider, the hook and the catalog take the result as it
14
15
  * is.
15
16
  *
16
- * Editor only: the `API_TYPE` context filter and the query clamp read
17
+ * The catalog only: the `API_TYPE` context filter and the query clamp read
17
18
  * `scopeApiTypes` alone.
18
19
  */
19
20
  export declare function resolveAnalyticsApiTypes(dashboards: Pick<DashboardFeatureConfig, 'analyticsApiTypes'> | undefined, config: Pick<ObservabilityFeaturesConfig, 'analyticsApiTypes'>, effectiveScopeApiTypes: readonly string[] | undefined): readonly string[] | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"resolve-analytics-api-types.d.ts","sourceRoot":"","sources":["../../src/routing/resolve-analytics-api-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,MAAM,SAAS,CAAC;AAEnF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,IAAI,CAAC,sBAAsB,EAAE,mBAAmB,CAAC,GAAG,SAAS,EACzE,MAAM,EAAE,IAAI,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,EAC9D,sBAAsB,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,GACpD,SAAS,MAAM,EAAE,GAAG,SAAS,CAI/B"}
1
+ {"version":3,"file":"resolve-analytics-api-types.d.ts","sourceRoot":"","sources":["../../src/routing/resolve-analytics-api-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,MAAM,SAAS,CAAC;AAEnF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,IAAI,CAAC,sBAAsB,EAAE,mBAAmB,CAAC,GAAG,SAAS,EACzE,MAAM,EAAE,IAAI,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,EAC9D,sBAAsB,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,GACpD,SAAS,MAAM,EAAE,GAAG,SAAS,CAI/B"}