@kong-ui-public/analytics-metric-provider 5.1.2 → 5.1.3

package/README.md

@@ -23,14 +23,6 @@ Query data for metric cards and render default "golden signal" metrics cards usi
 
 ## Usage
 
-First, create a wrapper around `<MetricsProviderInternal />` in the host app.  This wrapper is in charge of feeding environment-specific properties to the metrics provider, most notably:
-
-- `dataFetcher`, a function that calls the correct API to retrieve data for the provided query.
-- `hasTrendAccess`, a boolean ref that describes whether the current user is expected to be able to run trend queries.
-- `refreshInterval`, a number in milliseconds describing how often the cards should refresh.  (This value is eventually fed to the `refreshInterval` property of `useSWRV`.)
-
-For consistency, name your wrapper `<MetricsProvider>`.  Then, use it as follows:
-
 ### Global
 
 To query across all data for an organization, no properties are needed.  The provider's determination of whether the user has trend access is available as a slot property for translation purposes.

package/dist/types/components/{MetricsProviderInternal.vue.d.ts → MetricsProvider.vue.d.ts}

@@ -21,6 +21,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     filterValue: undefined;
     additionalFilter: undefined;
     queryReady: boolean;
+    refreshInterval: number;
     longCardTitles: boolean;
     containerTitle: undefined;
     description: undefined;
@@ -46,11 +47,13 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     filterValue: undefined;
     additionalFilter: undefined;
     queryReady: boolean;
+    refreshInterval: number;
     longCardTitles: boolean;
     containerTitle: undefined;
     description: undefined;
     abortController: undefined;
 }>>>, {
+    refreshInterval: number;
     description: string;
     dimension: "api_product" | "api_product_version" | "application" | "consumer" | "control_plane" | "control_plane_group" | "data_plane_node" | "gateway_service" | "route" | "status_code" | "status_code_grouped" | "time";
     additionalFilter: ExploreFilter[];
@@ -91,4 +94,4 @@ type __VLS_WithTemplateSlots<T, S> = T & {
         $slots: S;
     };
 };
-//# sourceMappingURL=MetricsProviderInternal.vue.d.ts.map
+//# sourceMappingURL=MetricsProvider.vue.d.ts.map

package/dist/types/components/MetricsProvider.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetricsProvider.vue.d.ts","sourceRoot":"","sources":["../../../src/components/MetricsProvider.vue.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,KAAK,aAAa,EAGlB,KAAK,SAAS,EACf,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAAe,aAAa,EAAE,MAAM,qCAAqC,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwNhF,wBAAwG;AACxG,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,6BAA6B,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CAAE,CAAC;AAC9M,KAAK,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI;KAE1B,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;QACxE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;KACb,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACT,CAAC;AACN,KAAK,cAAc,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAG,GAAG,EAAE,CAAC;AACxD,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}

package/dist/types/constants.d.ts

@@ -2,5 +2,6 @@ export declare const MAX_ANALYTICS_REQUEST_RETRIES = 2;
 export declare const ALL_STATUS_CODE_GROUPS: string[];
 export declare const STATUS_CODES_FAILED: string[];
 export declare const STATUS_CODES_SUCCESS: string[];
+export declare const DEFAULT_REFRESH_INTERVAL: number;
 export declare const INJECT_QUERY_PROVIDER = "analytics-query-provider";
 //# sourceMappingURL=constants.d.ts.map

package/dist/types/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B,IAAI,CAAA;AAC9C,eAAO,MAAM,sBAAsB,UAAsC,CAAA;AACzE,eAAO,MAAM,mBAAmB,UAAiB,CAAA;AACjD,eAAO,MAAM,oBAAoB,UAAwB,CAAA;AAEzD,eAAO,MAAM,qBAAqB,6BAA6B,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B,IAAI,CAAA;AAC9C,eAAO,MAAM,sBAAsB,UAAsC,CAAA;AACzE,eAAO,MAAM,mBAAmB,UAAiB,CAAA;AACjD,eAAO,MAAM,oBAAoB,UAAwB,CAAA;AACzD,eAAO,MAAM,wBAAwB,QAAY,CAAA;AACjD,eAAO,MAAM,qBAAqB,6BAA6B,CAAA"}

package/dist/types/index.d.ts

@@ -1,6 +1,6 @@
-import MetricsProviderInternal from './components/MetricsProviderInternal.vue';
+import MetricsProvider from './components/MetricsProvider.vue';
 import MetricsConsumer from './components/MetricsConsumer.vue';
 import { mockExploreResponseFromCypress, mockExploreResponse } from './mockExploreResponse';
-export { MetricsProviderInternal, MetricsConsumer, mockExploreResponseFromCypress, mockExploreResponse, };
+export { MetricsProvider, MetricsConsumer, mockExploreResponseFromCypress, mockExploreResponse, };
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,uBAAuB,MAAM,0CAA0C,CAAA;AAC9E,OAAO,eAAe,MAAM,kCAAkC,CAAA;AAC9D,OAAO,EAAE,8BAA8B,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAE3F,OAAO,EACL,uBAAuB,EACvB,eAAe,EACf,8BAA8B,EAC9B,mBAAmB,GACpB,CAAA;AAED,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,kCAAkC,CAAA;AAC9D,OAAO,eAAe,MAAM,kCAAkC,CAAA;AAC9D,OAAO,EAAE,8BAA8B,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAE3F,OAAO,EACL,eAAe,EACf,eAAe,EACf,8BAA8B,EAC9B,mBAAmB,GACpB,CAAA;AAED,cAAc,SAAS,CAAA"}