@perses-dev/plugin-system 0.23.1 → 0.25.0

package/dist/cjs/model/calculations.js

@@ -73,5 +73,10 @@ function sum(values) {
     return (0, _lodashEs.sumBy)(values, getValue);
 }
 function getValue(valueTuple) {
-    return valueTuple[1];
+    const value = valueTuple[1];
+    if (value !== null) {
+        return value;
+    }
+    // TODO: refactor utils so null can be returned and LastNotNull supported
+    return NaN;
 }

package/dist/cjs/model/index.js

@@ -18,10 +18,10 @@ _exportStar(require("./calculations"), exports);
 _exportStar(require("./datasource"), exports);
 _exportStar(require("./panels"), exports);
 _exportStar(require("./plugins"), exports);
-_exportStar(require("./time-series-queries"), exports);
-_exportStar(require("./variables"), exports);
 _exportStar(require("./plugin-base"), exports);
 _exportStar(require("./plugin-loading"), exports);
+_exportStar(require("./time-series-queries"), exports);
+_exportStar(require("./variables"), exports);
 function _exportStar(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) Object.defineProperty(to, k, {

package/dist/cjs/runtime/time-series-queries.js

@@ -21,14 +21,18 @@ function _export(target, all) {
     });
 }
 _export(exports, {
+    TIME_SERIES_QUERY_KEY: ()=>TIME_SERIES_QUERY_KEY,
     useTimeSeriesQuery: ()=>useTimeSeriesQuery,
-    useTimeSeriesQueries: ()=>useTimeSeriesQueries
+    useTimeSeriesQueries: ()=>useTimeSeriesQueries,
+    useActiveTimeSeriesQueries: ()=>useActiveTimeSeriesQueries,
+    getActiveTimeSeriesQueries: ()=>getActiveTimeSeriesQueries
 });
 const _reactQuery = require("@tanstack/react-query");
 const _templateVariables = require("./template-variables");
 const _timeRangeProvider = require("./TimeRangeProvider");
 const _datasources = require("./datasources");
 const _pluginRegistry = require("./plugin-registry");
+const TIME_SERIES_QUERY_KEY = 'TimeSeriesQuery';
 /**
  * Returns a serialized string of the current state of variable values.
  */ function getVariableValuesKey(v) {
@@ -70,7 +74,7 @@ function getQueryOptions({ plugin , definition , context  }) {
     };
 }
 const useTimeSeriesQuery = (definition, options)=>{
-    const { data: plugin  } = (0, _pluginRegistry.usePlugin)('TimeSeriesQuery', definition.spec.plugin.kind);
+    const { data: plugin  } = (0, _pluginRegistry.usePlugin)(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);
     const context = useTimeSeriesQueryContext();
     const { queryEnabled , queryKey  } = getQueryOptions({
         plugin,
@@ -97,7 +101,7 @@ const useTimeSeriesQuery = (definition, options)=>{
 function useTimeSeriesQueries(definitions, options) {
     const { getPlugin  } = (0, _pluginRegistry.usePluginRegistry)();
     const context = useTimeSeriesQueryContext();
-    const pluginLoaderResponse = (0, _pluginRegistry.usePlugins)('TimeSeriesQuery', definitions.map((d)=>({
+    const pluginLoaderResponse = (0, _pluginRegistry.usePlugins)(TIME_SERIES_QUERY_KEY, definitions.map((d)=>({
             kind: d.spec.plugin.kind
         })));
     return (0, _reactQuery.useQueries)({
@@ -118,7 +122,7 @@ function useTimeSeriesQueries(definitions, options) {
                         ...context,
                         suggestedStepMs: options === null || options === void 0 ? void 0 : options.suggestedStepMs
                     };
-                    const plugin = await getPlugin('TimeSeriesQuery', definition.spec.plugin.kind);
+                    const plugin = await getPlugin(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);
                     const data = await plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);
                     return data;
                 }
@@ -126,8 +130,9 @@ function useTimeSeriesQueries(definitions, options) {
         })
     });
 }
-function useTimeSeriesQueryContext() {
-    // Build the context object from data available at runtime
+/**
+ * Build the time series query context object from data available at runtime
+ */ function useTimeSeriesQueryContext() {
     const { absoluteTimeRange , refreshKey  } = (0, _timeRangeProvider.useTimeRange)();
     const variableState = (0, _templateVariables.useTemplateVariableValues)();
     const datasourceStore = (0, _datasources.useDatasourceStore)();
@@ -138,3 +143,21 @@ function useTimeSeriesQueryContext() {
         refreshKey
     };
 }
+function useActiveTimeSeriesQueries() {
+    const queryClient = (0, _reactQuery.useQueryClient)();
+    const queryCache = queryClient.getQueryCache();
+    return getActiveTimeSeriesQueries(queryCache);
+}
+function getActiveTimeSeriesQueries(cache) {
+    const queries = [];
+    for (const query of cache.findAll({
+        type: 'active'
+    })){
+        var ref;
+        const firstPart = (ref = query.queryKey) === null || ref === void 0 ? void 0 : ref[0];
+        if ((firstPart === null || firstPart === void 0 ? void 0 : firstPart.kind) && firstPart.kind.startsWith(TIME_SERIES_QUERY_KEY)) {
+            queries.push(query);
+        }
+    }
+    return queries;
+}

package/dist/model/calculations.d.ts

@@ -1,4 +1,4 @@
-import { TimeSeriesValueTuple } from './time-series-queries';
+import { TimeSeriesValueTuple } from '@perses-dev/core';
 export declare const CalculationsMap: {
     First: typeof first;
     Last: typeof last;

package/dist/model/calculations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"calculations.d.ts","sourceRoot":"","sources":["../../src/model/calculations.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAE7D,eAAO,MAAM,eAAe;;;;;;CAM3B,CAAC;AAEF,oBAAY,eAAe,GAAG,MAAM,OAAO,eAAe,CAAC;AAE3D,oBAAY,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AACF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAgB3E,CAAC;AAEX,eAAO,MAAM,mBAAmB,EAAE,eAAuB,CAAC;AAE1D,iBAAS,KAAK,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAGjE;AAED,iBAAS,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAKhE;AAED,iBAAS,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAGtE;AAED,iBAAS,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAGhE;AAED,iBAAS,GAAG,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAG/D"}
+{"version":3,"file":"calculations.d.ts","sourceRoot":"","sources":["../../src/model/calculations.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAGxD,eAAO,MAAM,eAAe;;;;;;CAM3B,CAAC;AAEF,oBAAY,eAAe,GAAG,MAAM,OAAO,eAAe,CAAC;AAE3D,oBAAY,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AACF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAgB3E,CAAC;AAEX,eAAO,MAAM,mBAAmB,EAAE,eAAuB,CAAC;AAE1D,iBAAS,KAAK,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAGjE;AAED,iBAAS,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAKhE;AAED,iBAAS,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAGtE;AAED,iBAAS,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAGhE;AAED,iBAAS,GAAG,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAG/D"}

package/dist/model/calculations.js

@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { findLast, meanBy, sumBy } from 'lodash-es';
+// TODO: move this file and calculations.test.ts to @perses-dev/core
 export const CalculationsMap = {
     First: first,
     Last: last,
@@ -58,7 +59,12 @@ function sum(values) {
     return sumBy(values, getValue);
 }
 function getValue(valueTuple) {
-    return valueTuple[1];
+    const value = valueTuple[1];
+    if (value !== null) {
+        return value;
+    }
+    // TODO: refactor utils so null can be returned and LastNotNull supported
+    return NaN;
 }
 
 //# sourceMappingURL=calculations.js.map

package/dist/model/calculations.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/model/calculations.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { findLast, meanBy, sumBy } from 'lodash-es';\nimport { TimeSeriesValueTuple } from './time-series-queries';\n\nexport const CalculationsMap = {\n  First: first,\n  Last: last,\n  LastNumber: lastNumber,\n  Mean: mean,\n  Sum: sum,\n};\n\nexport type CalculationType = keyof typeof CalculationsMap;\n\nexport type CalculationConfig = {\n  label: string;\n};\nexport const CALCULATIONS_CONFIG: Readonly<Record<CalculationType, CalculationConfig>> = {\n  First: {\n    label: 'First',\n  },\n  Last: {\n    label: 'Last',\n  },\n  LastNumber: {\n    label: 'Last number',\n  },\n  Mean: {\n    label: 'Mean',\n  },\n  Sum: {\n    label: 'Sum',\n  },\n} as const;\n\nexport const DEFAULT_CALCULATION: CalculationType = 'Sum';\n\nfunction first(values: TimeSeriesValueTuple[]): number | undefined {\n  const tuple = values[0];\n  return tuple === undefined ? undefined : getValue(tuple);\n}\n\nfunction last(values: TimeSeriesValueTuple[]): number | undefined {\n  if (values.length <= 0) return undefined;\n\n  const tuple = values[values.length - 1];\n  return tuple === undefined ? undefined : getValue(tuple);\n}\n\nfunction lastNumber(values: TimeSeriesValueTuple[]): number | undefined {\n  const tuple = findLast(values, (tuple) => isNaN(getValue(tuple)) === false);\n  return tuple === undefined ? undefined : getValue(tuple);\n}\n\nfunction mean(values: TimeSeriesValueTuple[]): number | undefined {\n  if (values.length <= 0) return undefined;\n  return meanBy(values, getValue);\n}\n\nfunction sum(values: TimeSeriesValueTuple[]): number | undefined {\n  if (values.length <= 0) return undefined;\n  return sumBy(values, getValue);\n}\n\nfunction getValue(valueTuple: TimeSeriesValueTuple) {\n  return valueTuple[1];\n}\n"],"names":["findLast","meanBy","sumBy","CalculationsMap","First","first","Last","last","LastNumber","lastNumber","Mean","mean","Sum","sum","CALCULATIONS_CONFIG","label","DEFAULT_CALCULATION","values","tuple","undefined","getValue","length","isNaN","valueTuple"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SAASA,QAAQ,EAAEC,MAAM,EAAEC,KAAK,QAAQ,WAAW,CAAC;AAGpD,OAAO,MAAMC,eAAe,GAAG;IAC7BC,KAAK,EAAEC,KAAK;IACZC,IAAI,EAAEC,IAAI;IACVC,UAAU,EAAEC,UAAU;IACtBC,IAAI,EAAEC,IAAI;IACVC,GAAG,EAAEC,GAAG;CACT,CAAC;AAOF,OAAO,MAAMC,mBAAmB,GAAyD;IACvFV,KAAK,EAAE;QACLW,KAAK,EAAE,OAAO;KACf;IACDT,IAAI,EAAE;QACJS,KAAK,EAAE,MAAM;KACd;IACDP,UAAU,EAAE;QACVO,KAAK,EAAE,aAAa;KACrB;IACDL,IAAI,EAAE;QACJK,KAAK,EAAE,MAAM;KACd;IACDH,GAAG,EAAE;QACHG,KAAK,EAAE,KAAK;KACb;CACF,AAAS,CAAC;AAEX,OAAO,MAAMC,mBAAmB,GAAoB,KAAK,CAAC;AAE1D,SAASX,KAAK,CAACY,MAA8B,EAAsB;IACjE,MAAMC,KAAK,GAAGD,MAAM,CAAC,CAAC,CAAC,AAAC;IACxB,OAAOC,KAAK,KAAKC,SAAS,GAAGA,SAAS,GAAGC,QAAQ,CAACF,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAASX,IAAI,CAACU,MAA8B,EAAsB;IAChE,IAAIA,MAAM,CAACI,MAAM,IAAI,CAAC,EAAE,OAAOF,SAAS,CAAC;IAEzC,MAAMD,KAAK,GAAGD,MAAM,CAACA,MAAM,CAACI,MAAM,GAAG,CAAC,CAAC,AAAC;IACxC,OAAOH,KAAK,KAAKC,SAAS,GAAGA,SAAS,GAAGC,QAAQ,CAACF,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAAST,UAAU,CAACQ,MAA8B,EAAsB;IACtE,MAAMC,KAAK,GAAGlB,QAAQ,CAACiB,MAAM,EAAE,CAACC,KAAK,GAAKI,KAAK,CAACF,QAAQ,CAACF,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC,AAAC;IAC5E,OAAOA,KAAK,KAAKC,SAAS,GAAGA,SAAS,GAAGC,QAAQ,CAACF,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAASP,IAAI,CAACM,MAA8B,EAAsB;IAChE,IAAIA,MAAM,CAACI,MAAM,IAAI,CAAC,EAAE,OAAOF,SAAS,CAAC;IACzC,OAAOlB,MAAM,CAACgB,MAAM,EAAEG,QAAQ,CAAC,CAAC;AAClC,CAAC;AAED,SAASP,GAAG,CAACI,MAA8B,EAAsB;IAC/D,IAAIA,MAAM,CAACI,MAAM,IAAI,CAAC,EAAE,OAAOF,SAAS,CAAC;IACzC,OAAOjB,KAAK,CAACe,MAAM,EAAEG,QAAQ,CAAC,CAAC;AACjC,CAAC;AAED,SAASA,QAAQ,CAACG,UAAgC,EAAE;IAClD,OAAOA,UAAU,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC"}
+{"version":3,"sources":["../../src/model/calculations.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { findLast, meanBy, sumBy } from 'lodash-es';\nimport { TimeSeriesValueTuple } from '@perses-dev/core';\n\n// TODO: move this file and calculations.test.ts to @perses-dev/core\nexport const CalculationsMap = {\n  First: first,\n  Last: last,\n  LastNumber: lastNumber,\n  Mean: mean,\n  Sum: sum,\n};\n\nexport type CalculationType = keyof typeof CalculationsMap;\n\nexport type CalculationConfig = {\n  label: string;\n};\nexport const CALCULATIONS_CONFIG: Readonly<Record<CalculationType, CalculationConfig>> = {\n  First: {\n    label: 'First',\n  },\n  Last: {\n    label: 'Last',\n  },\n  LastNumber: {\n    label: 'Last number',\n  },\n  Mean: {\n    label: 'Mean',\n  },\n  Sum: {\n    label: 'Sum',\n  },\n} as const;\n\nexport const DEFAULT_CALCULATION: CalculationType = 'Sum';\n\nfunction first(values: TimeSeriesValueTuple[]): number | undefined {\n  const tuple = values[0];\n  return tuple === undefined ? undefined : getValue(tuple);\n}\n\nfunction last(values: TimeSeriesValueTuple[]): number | undefined {\n  if (values.length <= 0) return undefined;\n\n  const tuple = values[values.length - 1];\n  return tuple === undefined ? undefined : getValue(tuple);\n}\n\nfunction lastNumber(values: TimeSeriesValueTuple[]): number | undefined {\n  const tuple = findLast(values, (tuple) => isNaN(getValue(tuple)) === false);\n  return tuple === undefined ? undefined : getValue(tuple);\n}\n\nfunction mean(values: TimeSeriesValueTuple[]): number | undefined {\n  if (values.length <= 0) return undefined;\n  return meanBy(values, getValue);\n}\n\nfunction sum(values: TimeSeriesValueTuple[]): number | undefined {\n  if (values.length <= 0) return undefined;\n  return sumBy(values, getValue);\n}\n\nfunction getValue(valueTuple: TimeSeriesValueTuple) {\n  const value = valueTuple[1];\n  if (value !== null) {\n    return value;\n  }\n  // TODO: refactor utils so null can be returned and LastNotNull supported\n  return NaN;\n}\n"],"names":["findLast","meanBy","sumBy","CalculationsMap","First","first","Last","last","LastNumber","lastNumber","Mean","mean","Sum","sum","CALCULATIONS_CONFIG","label","DEFAULT_CALCULATION","values","tuple","undefined","getValue","length","isNaN","valueTuple","value","NaN"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SAASA,QAAQ,EAAEC,MAAM,EAAEC,KAAK,QAAQ,WAAW,CAAC;AAGpD,oEAAoE;AACpE,OAAO,MAAMC,eAAe,GAAG;IAC7BC,KAAK,EAAEC,KAAK;IACZC,IAAI,EAAEC,IAAI;IACVC,UAAU,EAAEC,UAAU;IACtBC,IAAI,EAAEC,IAAI;IACVC,GAAG,EAAEC,GAAG;CACT,CAAC;AAOF,OAAO,MAAMC,mBAAmB,GAAyD;IACvFV,KAAK,EAAE;QACLW,KAAK,EAAE,OAAO;KACf;IACDT,IAAI,EAAE;QACJS,KAAK,EAAE,MAAM;KACd;IACDP,UAAU,EAAE;QACVO,KAAK,EAAE,aAAa;KACrB;IACDL,IAAI,EAAE;QACJK,KAAK,EAAE,MAAM;KACd;IACDH,GAAG,EAAE;QACHG,KAAK,EAAE,KAAK;KACb;CACF,AAAS,CAAC;AAEX,OAAO,MAAMC,mBAAmB,GAAoB,KAAK,CAAC;AAE1D,SAASX,KAAK,CAACY,MAA8B,EAAsB;IACjE,MAAMC,KAAK,GAAGD,MAAM,CAAC,CAAC,CAAC,AAAC;IACxB,OAAOC,KAAK,KAAKC,SAAS,GAAGA,SAAS,GAAGC,QAAQ,CAACF,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAASX,IAAI,CAACU,MAA8B,EAAsB;IAChE,IAAIA,MAAM,CAACI,MAAM,IAAI,CAAC,EAAE,OAAOF,SAAS,CAAC;IAEzC,MAAMD,KAAK,GAAGD,MAAM,CAACA,MAAM,CAACI,MAAM,GAAG,CAAC,CAAC,AAAC;IACxC,OAAOH,KAAK,KAAKC,SAAS,GAAGA,SAAS,GAAGC,QAAQ,CAACF,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAAST,UAAU,CAACQ,MAA8B,EAAsB;IACtE,MAAMC,KAAK,GAAGlB,QAAQ,CAACiB,MAAM,EAAE,CAACC,KAAK,GAAKI,KAAK,CAACF,QAAQ,CAACF,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC,AAAC;IAC5E,OAAOA,KAAK,KAAKC,SAAS,GAAGA,SAAS,GAAGC,QAAQ,CAACF,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAASP,IAAI,CAACM,MAA8B,EAAsB;IAChE,IAAIA,MAAM,CAACI,MAAM,IAAI,CAAC,EAAE,OAAOF,SAAS,CAAC;IACzC,OAAOlB,MAAM,CAACgB,MAAM,EAAEG,QAAQ,CAAC,CAAC;AAClC,CAAC;AAED,SAASP,GAAG,CAACI,MAA8B,EAAsB;IAC/D,IAAIA,MAAM,CAACI,MAAM,IAAI,CAAC,EAAE,OAAOF,SAAS,CAAC;IACzC,OAAOjB,KAAK,CAACe,MAAM,EAAEG,QAAQ,CAAC,CAAC;AACjC,CAAC;AAED,SAASA,QAAQ,CAACG,UAAgC,EAAE;IAClD,MAAMC,KAAK,GAAGD,UAAU,CAAC,CAAC,CAAC,AAAC;IAC5B,IAAIC,KAAK,KAAK,IAAI,EAAE;QAClB,OAAOA,KAAK,CAAC;IACf,CAAC;IACD,yEAAyE;IACzE,OAAOC,GAAG,CAAC;AACb,CAAC"}

package/dist/model/datasource.d.ts

@@ -9,4 +9,11 @@ export interface DatasourcePlugin<Spec = UnknownSpec, Client = unknown> extends
 export interface DatasourceClientOptions {
     proxyUrl?: string;
 }
+/**
+ * Common properties for all clients
+ */
+export interface DatasourceClient {
+    kind?: string;
+    healthCheck?: () => Promise<boolean>;
+}
 //# sourceMappingURL=datasource.d.ts.map

package/dist/model/datasource.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"datasource.d.ts","sourceRoot":"","sources":["../../src/model/datasource.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,IAAI,GAAG,WAAW,EAAE,MAAM,GAAG,OAAO,CAAE,SAAQ,MAAM,CAAC,IAAI,CAAC;IAC1F,YAAY,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,uBAAuB,KAAK,MAAM,CAAC;CACxE;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"datasource.d.ts","sourceRoot":"","sources":["../../src/model/datasource.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,IAAI,GAAG,WAAW,EAAE,MAAM,GAAG,OAAO,CAAE,SAAQ,MAAM,CAAC,IAAI,CAAC;IAC1F,YAAY,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,uBAAuB,KAAK,MAAM,CAAC;CACxE;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAE/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;CACtC"}

package/dist/model/datasource.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/model/datasource.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { UnknownSpec } from '@perses-dev/core';\nimport { Plugin } from './plugin-base';\n\n/**\n * Plugin that defines options for an external system that Perses talks to for data.\n */\nexport interface DatasourcePlugin<Spec = UnknownSpec, Client = unknown> extends Plugin<Spec> {\n  createClient: (spec: Spec, options: DatasourceClientOptions) => Client;\n}\n\nexport interface DatasourceClientOptions {\n  proxyUrl?: string;\n}\n"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,WAYC"}
+{"version":3,"sources":["../../src/model/datasource.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { UnknownSpec } from '@perses-dev/core';\nimport { Plugin } from './plugin-base';\n\n/**\n * Plugin that defines options for an external system that Perses talks to for data.\n */\nexport interface DatasourcePlugin<Spec = UnknownSpec, Client = unknown> extends Plugin<Spec> {\n  createClient: (spec: Spec, options: DatasourceClientOptions) => Client;\n}\n\nexport interface DatasourceClientOptions {\n  proxyUrl?: string;\n}\n\n/**\n * Common properties for all clients\n */\nexport interface DatasourceClient {\n  // TODO: set kind and define healthCheck function\n  kind?: string;\n  healthCheck?: () => Promise<boolean>;\n}\n"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,WAqBC"}

package/dist/model/index.d.ts

@@ -2,8 +2,8 @@ export * from './calculations';
 export * from './datasource';
 export * from './panels';
 export * from './plugins';
-export * from './time-series-queries';
-export * from './variables';
 export * from './plugin-base';
 export * from './plugin-loading';
+export * from './time-series-queries';
+export * from './variables';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/model/index.ts"],"names":[],"mappings":"AAaA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/model/index.ts"],"names":[],"mappings":"AAaA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC"}

package/dist/model/index.js

@@ -14,9 +14,9 @@ export * from './calculations';
 export * from './datasource';
 export * from './panels';
 export * from './plugins';
-export * from './time-series-queries';
-export * from './variables';
 export * from './plugin-base';
 export * from './plugin-loading';
+export * from './time-series-queries';
+export * from './variables';
 
 //# sourceMappingURL=index.js.map

package/dist/model/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/model/index.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nexport * from './calculations';\nexport * from './datasource';\nexport * from './panels';\nexport * from './plugins';\nexport * from './time-series-queries';\nexport * from './variables';\nexport * from './plugin-base';\nexport * from './plugin-loading';\n"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC"}
+{"version":3,"sources":["../../src/model/index.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nexport * from './calculations';\nexport * from './datasource';\nexport * from './panels';\nexport * from './plugins';\nexport * from './plugin-base';\nexport * from './plugin-loading';\nexport * from './time-series-queries';\nexport * from './variables';\n"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC"}

package/dist/model/time-series-queries.d.ts

@@ -1,4 +1,5 @@
-import { AbsoluteTimeRange, UnixTimeMs, UnknownSpec } from '@perses-dev/core';
+import { Query, QueryKey } from '@tanstack/react-query';
+import { AbsoluteTimeRange, TimeSeriesValueTuple, UnknownSpec, Labels, Notice } from '@perses-dev/core';
 import { DatasourceStore, VariableStateMap } from '../runtime';
 import { Plugin } from './plugin-base';
 /**
@@ -30,13 +31,18 @@ export interface TimeSeriesQueryContext {
 export interface TimeSeriesData {
     timeRange?: AbsoluteTimeRange;
     stepMs?: number;
-    series: Iterable<TimeSeries>;
+    series: TimeSeries[];
+    metadata?: TimeSeriesMetadata;
 }
 export interface TimeSeries {
     name: string;
-    values: Iterable<TimeSeriesValueTuple>;
+    values: TimeSeriesValueTuple[];
     formattedName?: string;
+    labels?: Labels;
 }
-export declare type TimeSeriesValueTuple = [timestamp: UnixTimeMs, value: number];
+export interface TimeSeriesMetadata {
+    notices?: Notice[];
+}
+export declare type TimeSeriesDataQuery = Query<TimeSeriesData, unknown, TimeSeriesData, QueryKey>;
 export {};
 //# sourceMappingURL=time-series-queries.d.ts.map

package/dist/model/time-series-queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"time-series-queries.d.ts","sourceRoot":"","sources":["../../src/model/time-series-queries.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC;;GAEG;AACH,aAAK,iCAAiC,GAAG;IACvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,IAAI,GAAG,WAAW,CAAE,SAAQ,MAAM,CAAC,IAAI,CAAC;IAC7E,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,sBAAsB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAExF,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,sBAAsB,KAAK,iCAAiC,CAAC;CAC5F;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,iBAAiB,CAAC;IAC7B,aAAa,EAAE,gBAAgB,CAAC;IAChC,eAAe,EAAE,eAAe,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,QAAQ,CAAC,oBAAoB,CAAC,CAAC;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,oBAAY,oBAAoB,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC"}
+{"version":3,"file":"time-series-queries.d.ts","sourceRoot":"","sources":["../../src/model/time-series-queries.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACxG,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC;;GAEG;AACH,aAAK,iCAAiC,GAAG;IACvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,IAAI,GAAG,WAAW,CAAE,SAAQ,MAAM,CAAC,IAAI,CAAC;IAC7E,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,sBAAsB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAExF,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,sBAAsB,KAAK,iCAAiC,CAAC;CAC5F;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,iBAAiB,CAAC;IAC7B,aAAa,EAAE,gBAAgB,CAAC;IAChC,eAAe,EAAE,eAAe,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,kBAAkB,CAAC;CAC/B;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,oBAAoB,EAAE,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,oBAAY,mBAAmB,GAAG,KAAK,CAAC,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC"}

package/dist/model/time-series-queries.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/model/time-series-queries.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { AbsoluteTimeRange, UnixTimeMs, UnknownSpec } from '@perses-dev/core';\nimport { DatasourceStore, VariableStateMap } from '../runtime';\nimport { Plugin } from './plugin-base';\n\n/**\n * An object containing all the dependencies of a TimeSeriesQuery.\n */\ntype TimeSeriesQueryPluginDependencies = {\n  /**\n   * Returns a list of variables name this time series query depends on.\n   */\n  variables?: string[];\n};\n\n/**\n * A plugin for running time series queries.\n */\nexport interface TimeSeriesQueryPlugin<Spec = UnknownSpec> extends Plugin<Spec> {\n  getTimeSeriesData: (spec: Spec, ctx: TimeSeriesQueryContext) => Promise<TimeSeriesData>;\n\n  dependsOn?: (spec: Spec, ctx: TimeSeriesQueryContext) => TimeSeriesQueryPluginDependencies;\n}\n\n/**\n * Context available to TimeSeriesQuery plugins at runtime.\n */\nexport interface TimeSeriesQueryContext {\n  suggestedStepMs?: number;\n  timeRange: AbsoluteTimeRange;\n  variableState: VariableStateMap;\n  datasourceStore: DatasourceStore;\n  refreshKey: string;\n}\n\nexport interface TimeSeriesData {\n  timeRange?: AbsoluteTimeRange;\n  stepMs?: number;\n  series: Iterable<TimeSeries>;\n}\n\nexport interface TimeSeries {\n  name: string;\n  values: Iterable<TimeSeriesValueTuple>;\n  formattedName?: string;\n}\n\nexport type TimeSeriesValueTuple = [timestamp: UnixTimeMs, value: number];\n"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,WA8C0E"}
+{"version":3,"sources":["../../src/model/time-series-queries.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { Query, QueryKey } from '@tanstack/react-query';\nimport { AbsoluteTimeRange, TimeSeriesValueTuple, UnknownSpec, Labels, Notice } from '@perses-dev/core';\nimport { DatasourceStore, VariableStateMap } from '../runtime';\nimport { Plugin } from './plugin-base';\n\n/**\n * An object containing all the dependencies of a TimeSeriesQuery.\n */\ntype TimeSeriesQueryPluginDependencies = {\n  /**\n   * Returns a list of variables name this time series query depends on.\n   */\n  variables?: string[];\n};\n\n/**\n * A plugin for running time series queries.\n */\nexport interface TimeSeriesQueryPlugin<Spec = UnknownSpec> extends Plugin<Spec> {\n  getTimeSeriesData: (spec: Spec, ctx: TimeSeriesQueryContext) => Promise<TimeSeriesData>;\n\n  dependsOn?: (spec: Spec, ctx: TimeSeriesQueryContext) => TimeSeriesQueryPluginDependencies;\n}\n\n/**\n * Context available to TimeSeriesQuery plugins at runtime.\n */\nexport interface TimeSeriesQueryContext {\n  suggestedStepMs?: number;\n  timeRange: AbsoluteTimeRange;\n  variableState: VariableStateMap;\n  datasourceStore: DatasourceStore;\n  refreshKey: string;\n}\n\nexport interface TimeSeriesData {\n  timeRange?: AbsoluteTimeRange;\n  stepMs?: number;\n  series: TimeSeries[];\n  metadata?: TimeSeriesMetadata;\n}\n\nexport interface TimeSeries {\n  name: string;\n  values: TimeSeriesValueTuple[];\n  formattedName?: string;\n  labels?: Labels;\n}\n\nexport interface TimeSeriesMetadata {\n  notices?: Notice[];\n}\n\nexport type TimeSeriesDataQuery = Query<TimeSeriesData, unknown, TimeSeriesData, QueryKey>;\n"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,WAqD2F"}

package/dist/runtime/time-series-queries.d.ts

@@ -1,13 +1,24 @@
+import { QueryCache } from '@tanstack/react-query';
 import { TimeSeriesQueryDefinition } from '@perses-dev/core';
+import { TimeSeriesData, TimeSeriesDataQuery } from '../model';
 export interface UseTimeSeriesQueryOptions {
     suggestedStepMs?: number;
 }
+export declare const TIME_SERIES_QUERY_KEY = "TimeSeriesQuery";
 /**
  * Runs a time series query using a plugin and returns the results.
  */
-export declare const useTimeSeriesQuery: (definition: TimeSeriesQueryDefinition, options?: UseTimeSeriesQueryOptions) => import("@tanstack/react-query").UseQueryResult<import("../model").TimeSeriesData, unknown>;
+export declare const useTimeSeriesQuery: (definition: TimeSeriesQueryDefinition, options?: UseTimeSeriesQueryOptions) => import("@tanstack/react-query").UseQueryResult<TimeSeriesData, unknown>;
 /**
  * Runs multiple time series queries using plugins and returns the results.
  */
-export declare function useTimeSeriesQueries(definitions: TimeSeriesQueryDefinition[], options?: UseTimeSeriesQueryOptions): import("@tanstack/react-query").UseQueryResult<import("../model").TimeSeriesData, unknown>[];
+export declare function useTimeSeriesQueries(definitions: TimeSeriesQueryDefinition[], options?: UseTimeSeriesQueryOptions): import("@tanstack/react-query").UseQueryResult<TimeSeriesData, unknown>[];
+/**
+ * Get active time series queries for query results summary
+ */
+export declare function useActiveTimeSeriesQueries(): TimeSeriesDataQuery[];
+/**
+ * Filter all cached queries down to only active time series queries
+ */
+export declare function getActiveTimeSeriesQueries(cache: QueryCache): TimeSeriesDataQuery[];
 //# sourceMappingURL=time-series-queries.d.ts.map

package/dist/runtime/time-series-queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"time-series-queries.d.ts","sourceRoot":"","sources":["../../src/runtime/time-series-queries.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAU7D,MAAM,WAAW,yBAAyB;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAkDD;;GAEG;AACH,eAAO,MAAM,kBAAkB,eAAgB,yBAAyB,YAAY,yBAAyB,+FAkB5G,CAAC;AAEF;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,yBAAyB,EAAE,EAAE,OAAO,CAAC,EAAE,yBAAyB,gGA0BjH"}
+{"version":3,"file":"time-series-queries.d.ts","sourceRoot":"","sources":["../../src/runtime/time-series-queries.ts"],"names":[],"mappings":"AAaA,OAAO,EAA+C,UAAU,EAAY,MAAM,uBAAuB,CAAC;AAC1G,OAAO,EAAE,yBAAyB,EAAe,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAiD,MAAM,UAAU,CAAC;AAO9G,MAAM,WAAW,yBAAyB;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,eAAO,MAAM,qBAAqB,oBAAoB,CAAC;AAmDvD;;GAEG;AACH,eAAO,MAAM,kBAAkB,eAAgB,yBAAyB,YAAY,yBAAyB,4EAkB5G,CAAC;AAEF;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,yBAAyB,EAAE,EAAE,OAAO,CAAC,EAAE,yBAAyB,6EA0BjH;AAkBD;;GAEG;AACH,wBAAgB,0BAA0B,0BAIzC;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,UAAU,yBAW3D"}

package/dist/runtime/time-series-queries.js

@@ -10,11 +10,12 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-import { useQuery, useQueries } from '@tanstack/react-query';
+import { useQuery, useQueries, useQueryClient } from '@tanstack/react-query';
 import { useTemplateVariableValues } from './template-variables';
 import { useTimeRange } from './TimeRangeProvider';
 import { useDatasourceStore } from './datasources';
 import { usePlugin, usePluginRegistry, usePlugins } from './plugin-registry';
+export const TIME_SERIES_QUERY_KEY = 'TimeSeriesQuery';
 /**
  * Returns a serialized string of the current state of variable values.
  */ function getVariableValuesKey(v) {
@@ -58,7 +59,7 @@ function getQueryOptions({ plugin , definition , context  }) {
 /**
  * Runs a time series query using a plugin and returns the results.
  */ export const useTimeSeriesQuery = (definition, options)=>{
-    const { data: plugin  } = usePlugin('TimeSeriesQuery', definition.spec.plugin.kind);
+    const { data: plugin  } = usePlugin(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);
     const context = useTimeSeriesQueryContext();
     const { queryEnabled , queryKey  } = getQueryOptions({
         plugin,
@@ -87,7 +88,7 @@ function getQueryOptions({ plugin , definition , context  }) {
  */ export function useTimeSeriesQueries(definitions, options) {
     const { getPlugin  } = usePluginRegistry();
     const context = useTimeSeriesQueryContext();
-    const pluginLoaderResponse = usePlugins('TimeSeriesQuery', definitions.map((d)=>({
+    const pluginLoaderResponse = usePlugins(TIME_SERIES_QUERY_KEY, definitions.map((d)=>({
             kind: d.spec.plugin.kind
         })));
     return useQueries({
@@ -108,7 +109,7 @@ function getQueryOptions({ plugin , definition , context  }) {
                         ...context,
                         suggestedStepMs: options === null || options === void 0 ? void 0 : options.suggestedStepMs
                     };
-                    const plugin = await getPlugin('TimeSeriesQuery', definition.spec.plugin.kind);
+                    const plugin = await getPlugin(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);
                     const data = await plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);
                     return data;
                 }
@@ -116,8 +117,9 @@ function getQueryOptions({ plugin , definition , context  }) {
         })
     });
 }
-function useTimeSeriesQueryContext() {
-    // Build the context object from data available at runtime
+/**
+ * Build the time series query context object from data available at runtime
+ */ function useTimeSeriesQueryContext() {
     const { absoluteTimeRange , refreshKey  } = useTimeRange();
     const variableState = useTemplateVariableValues();
     const datasourceStore = useDatasourceStore();
@@ -128,5 +130,27 @@ function useTimeSeriesQueryContext() {
         refreshKey
     };
 }
+/**
+ * Get active time series queries for query results summary
+ */ export function useActiveTimeSeriesQueries() {
+    const queryClient = useQueryClient();
+    const queryCache = queryClient.getQueryCache();
+    return getActiveTimeSeriesQueries(queryCache);
+}
+/**
+ * Filter all cached queries down to only active time series queries
+ */ export function getActiveTimeSeriesQueries(cache) {
+    const queries = [];
+    for (const query of cache.findAll({
+        type: 'active'
+    })){
+        var ref;
+        const firstPart = (ref = query.queryKey) === null || ref === void 0 ? void 0 : ref[0];
+        if ((firstPart === null || firstPart === void 0 ? void 0 : firstPart.kind) && firstPart.kind.startsWith(TIME_SERIES_QUERY_KEY)) {
+            queries.push(query);
+        }
+    }
+    return queries;
+}
 
 //# sourceMappingURL=time-series-queries.js.map

package/dist/runtime/time-series-queries.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/runtime/time-series-queries.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { TimeSeriesQueryDefinition } from '@perses-dev/core';\nimport { useQuery, useQueries } from '@tanstack/react-query';\nimport { TimeSeriesQueryContext } from '../model';\nimport { TimeSeriesQueryPlugin } from '../model';\nimport { VariableStateMap } from './template-variables';\nimport { useTemplateVariableValues } from './template-variables';\nimport { useTimeRange } from './TimeRangeProvider';\nimport { useDatasourceStore } from './datasources';\nimport { usePlugin, usePluginRegistry, usePlugins } from './plugin-registry';\n\nexport interface UseTimeSeriesQueryOptions {\n  suggestedStepMs?: number;\n}\n\n/**\n * Returns a serialized string of the current state of variable values.\n */\nfunction getVariableValuesKey(v: VariableStateMap) {\n  return Object.values(v)\n    .map((v) => JSON.stringify(v.value))\n    .join(',');\n}\n\nfunction filterVariableStateMap(v: VariableStateMap, names?: string[]) {\n  if (!names) {\n    return v;\n  }\n  return Object.fromEntries(Object.entries(v).filter(([name]) => names.includes(name)));\n}\n\nfunction getQueryOptions({\n  plugin,\n  definition,\n  context,\n}: {\n  plugin?: TimeSeriesQueryPlugin;\n  definition: TimeSeriesQueryDefinition;\n  context: TimeSeriesQueryContext;\n}) {\n  const { timeRange, datasourceStore, suggestedStepMs, variableState, refreshKey } = context;\n\n  const dependencies = plugin?.dependsOn ? plugin.dependsOn(definition.spec.plugin.spec, context) : {};\n  const variableDependencies = dependencies?.variables;\n\n  // Determine queryKey\n  const filteredVariabledState = filterVariableStateMap(variableState, variableDependencies);\n  const variablesValueKey = getVariableValuesKey(filteredVariabledState);\n  const queryKey = [definition, timeRange, datasourceStore, suggestedStepMs, variablesValueKey, refreshKey] as const;\n\n  // Determine queryEnabled\n  let waitToLoad = false;\n  if (variableDependencies) {\n    waitToLoad = variableDependencies.some((v) => variableState[v]?.loading);\n  }\n  const queryEnabled = plugin !== undefined && !waitToLoad;\n\n  return {\n    queryKey,\n    queryEnabled,\n  };\n}\n\n/**\n * Runs a time series query using a plugin and returns the results.\n */\nexport const useTimeSeriesQuery = (definition: TimeSeriesQueryDefinition, options?: UseTimeSeriesQueryOptions) => {\n  const { data: plugin } = usePlugin('TimeSeriesQuery', definition.spec.plugin.kind);\n  const context = useTimeSeriesQueryContext();\n\n  const { queryEnabled, queryKey } = getQueryOptions({ plugin, definition, context });\n  return useQuery({\n    enabled: queryEnabled,\n    queryKey: queryKey,\n    queryFn: () => {\n      // The 'enabled' option should prevent this from happening, but make TypeScript happy by checking\n      if (plugin === undefined) {\n        throw new Error('Expected plugin to be loaded');\n      }\n      // Keep options out of query key so we don't re-run queries because suggested step changes\n      const ctx: TimeSeriesQueryContext = { ...context, suggestedStepMs: options?.suggestedStepMs };\n      return plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);\n    },\n  });\n};\n\n/**\n * Runs multiple time series queries using plugins and returns the results.\n */\nexport function useTimeSeriesQueries(definitions: TimeSeriesQueryDefinition[], options?: UseTimeSeriesQueryOptions) {\n  const { getPlugin } = usePluginRegistry();\n  const context = useTimeSeriesQueryContext();\n\n  const pluginLoaderResponse = usePlugins(\n    'TimeSeriesQuery',\n    definitions.map((d) => ({ kind: d.spec.plugin.kind }))\n  );\n\n  return useQueries({\n    queries: definitions.map((definition, idx) => {\n      const plugin = pluginLoaderResponse[idx]?.data;\n      const { queryEnabled, queryKey } = getQueryOptions({ plugin, definition, context });\n      return {\n        enabled: queryEnabled,\n        queryKey: queryKey,\n        queryFn: async () => {\n          // Keep options out of query key so we don't re-run queries because suggested step changes\n          const ctx: TimeSeriesQueryContext = { ...context, suggestedStepMs: options?.suggestedStepMs };\n          const plugin = await getPlugin('TimeSeriesQuery', definition.spec.plugin.kind);\n          const data = await plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);\n          return data;\n        },\n      };\n    }),\n  });\n}\n\nfunction useTimeSeriesQueryContext(): TimeSeriesQueryContext {\n  // Build the context object from data available at runtime\n  const { absoluteTimeRange, refreshKey } = useTimeRange();\n  const variableState = useTemplateVariableValues();\n  const datasourceStore = useDatasourceStore();\n\n  return {\n    timeRange: absoluteTimeRange,\n    variableState,\n    datasourceStore,\n    refreshKey,\n  };\n}\n"],"names":["useQuery","useQueries","useTemplateVariableValues","useTimeRange","useDatasourceStore","usePlugin","usePluginRegistry","usePlugins","getVariableValuesKey","v","Object","values","map","JSON","stringify","value","join","filterVariableStateMap","names","fromEntries","entries","filter","name","includes","getQueryOptions","plugin","definition","context","timeRange","datasourceStore","suggestedStepMs","variableState","refreshKey","dependencies","dependsOn","spec","variableDependencies","variables","filteredVariabledState","variablesValueKey","queryKey","waitToLoad","some","loading","queryEnabled","undefined","useTimeSeriesQuery","options","data","kind","useTimeSeriesQueryContext","enabled","queryFn","Error","ctx","getTimeSeriesData","useTimeSeriesQueries","definitions","getPlugin","pluginLoaderResponse","d","queries","idx","absoluteTimeRange"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAGjC,SAASA,QAAQ,EAAEC,UAAU,QAAQ,uBAAuB,CAAC;AAI7D,SAASC,yBAAyB,QAAQ,sBAAsB,CAAC;AACjE,SAASC,YAAY,QAAQ,qBAAqB,CAAC;AACnD,SAASC,kBAAkB,QAAQ,eAAe,CAAC;AACnD,SAASC,SAAS,EAAEC,iBAAiB,EAAEC,UAAU,QAAQ,mBAAmB,CAAC;AAM7E;;CAEC,GACD,SAASC,oBAAoB,CAACC,CAAmB,EAAE;IACjD,OAAOC,MAAM,CAACC,MAAM,CAACF,CAAC,CAAC,CACpBG,GAAG,CAAC,CAACH,CAAC,GAAKI,IAAI,CAACC,SAAS,CAACL,CAAC,CAACM,KAAK,CAAC,CAAC,CACnCC,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,SAASC,sBAAsB,CAACR,CAAmB,EAAES,KAAgB,EAAE;IACrE,IAAI,CAACA,KAAK,EAAE;QACV,OAAOT,CAAC,CAAC;IACX,CAAC;IACD,OAAOC,MAAM,CAACS,WAAW,CAACT,MAAM,CAACU,OAAO,CAACX,CAAC,CAAC,CAACY,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,GAAKJ,KAAK,CAACK,QAAQ,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC;AACxF,CAAC;AAED,SAASE,eAAe,CAAC,EACvBC,MAAM,CAAA,EACNC,UAAU,CAAA,EACVC,OAAO,CAAA,EAKR,EAAE;IACD,MAAM,EAAEC,SAAS,CAAA,EAAEC,eAAe,CAAA,EAAEC,eAAe,CAAA,EAAEC,aAAa,CAAA,EAAEC,UAAU,CAAA,EAAE,GAAGL,OAAO,AAAC;IAE3F,MAAMM,YAAY,GAAGR,CAAAA,MAAM,aAANA,MAAM,WAAW,GAAjBA,KAAAA,CAAiB,GAAjBA,MAAM,CAAES,SAAS,CAAA,GAAGT,MAAM,CAACS,SAAS,CAACR,UAAU,CAACS,IAAI,CAACV,MAAM,CAACU,IAAI,EAAER,OAAO,CAAC,GAAG,EAAE,AAAC;IACrG,MAAMS,oBAAoB,GAAGH,YAAY,aAAZA,YAAY,WAAW,GAAvBA,KAAAA,CAAuB,GAAvBA,YAAY,CAAEI,SAAS,AAAC;IAErD,qBAAqB;IACrB,MAAMC,sBAAsB,GAAGrB,sBAAsB,CAACc,aAAa,EAAEK,oBAAoB,CAAC,AAAC;IAC3F,MAAMG,iBAAiB,GAAG/B,oBAAoB,CAAC8B,sBAAsB,CAAC,AAAC;IACvE,MAAME,QAAQ,GAAG;QAACd,UAAU;QAAEE,SAAS;QAAEC,eAAe;QAAEC,eAAe;QAAES,iBAAiB;QAAEP,UAAU;KAAC,AAAS,AAAC;IAEnH,yBAAyB;IACzB,IAAIS,UAAU,GAAG,KAAK,AAAC;IACvB,IAAIL,oBAAoB,EAAE;QACxBK,UAAU,GAAGL,oBAAoB,CAACM,IAAI,CAAC,CAACjC,CAAC;gBAAKsB,GAAgB;YAAhBA,OAAAA,CAAAA,GAAgB,GAAhBA,aAAa,CAACtB,CAAC,CAAC,cAAhBsB,GAAgB,WAAS,GAAzBA,KAAAA,CAAyB,GAAzBA,GAAgB,CAAEY,OAAO,CAAA;SAAA,CAAC,CAAC;IAC3E,CAAC;IACD,MAAMC,YAAY,GAAGnB,MAAM,KAAKoB,SAAS,IAAI,CAACJ,UAAU,AAAC;IAEzD,OAAO;QACLD,QAAQ;QACRI,YAAY;KACb,CAAC;AACJ,CAAC;AAED;;CAEC,GACD,OAAO,MAAME,kBAAkB,GAAG,CAACpB,UAAqC,EAAEqB,OAAmC,GAAK;IAChH,MAAM,EAAEC,IAAI,EAAEvB,MAAM,CAAA,EAAE,GAAGpB,SAAS,CAAC,iBAAiB,EAAEqB,UAAU,CAACS,IAAI,CAACV,MAAM,CAACwB,IAAI,CAAC,AAAC;IACnF,MAAMtB,OAAO,GAAGuB,yBAAyB,EAAE,AAAC;IAE5C,MAAM,EAAEN,YAAY,CAAA,EAAEJ,QAAQ,CAAA,EAAE,GAAGhB,eAAe,CAAC;QAAEC,MAAM;QAAEC,UAAU;QAAEC,OAAO;KAAE,CAAC,AAAC;IACpF,OAAO3B,QAAQ,CAAC;QACdmD,OAAO,EAAEP,YAAY;QACrBJ,QAAQ,EAAEA,QAAQ;QAClBY,OAAO,EAAE,IAAM;YACb,iGAAiG;YACjG,IAAI3B,MAAM,KAAKoB,SAAS,EAAE;gBACxB,MAAM,IAAIQ,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YACD,0FAA0F;YAC1F,MAAMC,GAAG,GAA2B;gBAAE,GAAG3B,OAAO;gBAAEG,eAAe,EAAEiB,OAAO,aAAPA,OAAO,WAAiB,GAAxBA,KAAAA,CAAwB,GAAxBA,OAAO,CAAEjB,eAAe;aAAE,AAAC;YAC9F,OAAOL,MAAM,CAAC8B,iBAAiB,CAAC7B,UAAU,CAACS,IAAI,CAACV,MAAM,CAACU,IAAI,EAAEmB,GAAG,CAAC,CAAC;QACpE,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;CAEC,GACD,OAAO,SAASE,oBAAoB,CAACC,WAAwC,EAAEV,OAAmC,EAAE;IAClH,MAAM,EAAEW,SAAS,CAAA,EAAE,GAAGpD,iBAAiB,EAAE,AAAC;IAC1C,MAAMqB,OAAO,GAAGuB,yBAAyB,EAAE,AAAC;IAE5C,MAAMS,oBAAoB,GAAGpD,UAAU,CACrC,iBAAiB,EACjBkD,WAAW,CAAC7C,GAAG,CAAC,CAACgD,CAAC,GAAM,CAAA;YAAEX,IAAI,EAAEW,CAAC,CAACzB,IAAI,CAACV,MAAM,CAACwB,IAAI;SAAE,CAAA,AAAC,CAAC,CACvD,AAAC;IAEF,OAAOhD,UAAU,CAAC;QAChB4D,OAAO,EAAEJ,WAAW,CAAC7C,GAAG,CAAC,CAACc,UAAU,EAAEoC,GAAG,GAAK;gBAC7BH,GAAyB;YAAxC,MAAMlC,MAAM,GAAGkC,CAAAA,GAAyB,GAAzBA,oBAAoB,CAACG,GAAG,CAAC,cAAzBH,GAAyB,WAAM,GAA/BA,KAAAA,CAA+B,GAA/BA,GAAyB,CAAEX,IAAI,AAAC;YAC/C,MAAM,EAAEJ,YAAY,CAAA,EAAEJ,QAAQ,CAAA,EAAE,GAAGhB,eAAe,CAAC;gBAAEC,MAAM;gBAAEC,UAAU;gBAAEC,OAAO;aAAE,CAAC,AAAC;YACpF,OAAO;gBACLwB,OAAO,EAAEP,YAAY;gBACrBJ,QAAQ,EAAEA,QAAQ;gBAClBY,OAAO,EAAE,UAAY;oBACnB,0FAA0F;oBAC1F,MAAME,GAAG,GAA2B;wBAAE,GAAG3B,OAAO;wBAAEG,eAAe,EAAEiB,OAAO,aAAPA,OAAO,WAAiB,GAAxBA,KAAAA,CAAwB,GAAxBA,OAAO,CAAEjB,eAAe;qBAAE,AAAC;oBAC9F,MAAML,MAAM,GAAG,MAAMiC,SAAS,CAAC,iBAAiB,EAAEhC,UAAU,CAACS,IAAI,CAACV,MAAM,CAACwB,IAAI,CAAC,AAAC;oBAC/E,MAAMD,IAAI,GAAG,MAAMvB,MAAM,CAAC8B,iBAAiB,CAAC7B,UAAU,CAACS,IAAI,CAACV,MAAM,CAACU,IAAI,EAAEmB,GAAG,CAAC,AAAC;oBAC9E,OAAON,IAAI,CAAC;gBACd,CAAC;aACF,CAAC;QACJ,CAAC,CAAC;KACH,CAAC,CAAC;AACL,CAAC;AAED,SAASE,yBAAyB,GAA2B;IAC3D,0DAA0D;IAC1D,MAAM,EAAEa,iBAAiB,CAAA,EAAE/B,UAAU,CAAA,EAAE,GAAG7B,YAAY,EAAE,AAAC;IACzD,MAAM4B,aAAa,GAAG7B,yBAAyB,EAAE,AAAC;IAClD,MAAM2B,eAAe,GAAGzB,kBAAkB,EAAE,AAAC;IAE7C,OAAO;QACLwB,SAAS,EAAEmC,iBAAiB;QAC5BhC,aAAa;QACbF,eAAe;QACfG,UAAU;KACX,CAAC;AACJ,CAAC"}
+{"version":3,"sources":["../../src/runtime/time-series-queries.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { useQuery, useQueries, useQueryClient, Query, QueryCache, QueryKey } from '@tanstack/react-query';\nimport { TimeSeriesQueryDefinition, UnknownSpec } from '@perses-dev/core';\nimport { TimeSeriesData, TimeSeriesDataQuery, TimeSeriesQueryContext, TimeSeriesQueryPlugin } from '../model';\nimport { VariableStateMap } from './template-variables';\nimport { useTemplateVariableValues } from './template-variables';\nimport { useTimeRange } from './TimeRangeProvider';\nimport { useDatasourceStore } from './datasources';\nimport { usePlugin, usePluginRegistry, usePlugins } from './plugin-registry';\n\nexport interface UseTimeSeriesQueryOptions {\n  suggestedStepMs?: number;\n}\n\nexport const TIME_SERIES_QUERY_KEY = 'TimeSeriesQuery';\n\n/**\n * Returns a serialized string of the current state of variable values.\n */\nfunction getVariableValuesKey(v: VariableStateMap) {\n  return Object.values(v)\n    .map((v) => JSON.stringify(v.value))\n    .join(',');\n}\n\nfunction filterVariableStateMap(v: VariableStateMap, names?: string[]) {\n  if (!names) {\n    return v;\n  }\n  return Object.fromEntries(Object.entries(v).filter(([name]) => names.includes(name)));\n}\n\nfunction getQueryOptions({\n  plugin,\n  definition,\n  context,\n}: {\n  plugin?: TimeSeriesQueryPlugin;\n  definition: TimeSeriesQueryDefinition;\n  context: TimeSeriesQueryContext;\n}) {\n  const { timeRange, datasourceStore, suggestedStepMs, variableState, refreshKey } = context;\n\n  const dependencies = plugin?.dependsOn ? plugin.dependsOn(definition.spec.plugin.spec, context) : {};\n  const variableDependencies = dependencies?.variables;\n\n  // Determine queryKey\n  const filteredVariabledState = filterVariableStateMap(variableState, variableDependencies);\n  const variablesValueKey = getVariableValuesKey(filteredVariabledState);\n  const queryKey = [definition, timeRange, datasourceStore, suggestedStepMs, variablesValueKey, refreshKey] as const;\n\n  // Determine queryEnabled\n  let waitToLoad = false;\n  if (variableDependencies) {\n    waitToLoad = variableDependencies.some((v) => variableState[v]?.loading);\n  }\n\n  const queryEnabled = plugin !== undefined && !waitToLoad;\n\n  return {\n    queryKey,\n    queryEnabled,\n  };\n}\n\n/**\n * Runs a time series query using a plugin and returns the results.\n */\nexport const useTimeSeriesQuery = (definition: TimeSeriesQueryDefinition, options?: UseTimeSeriesQueryOptions) => {\n  const { data: plugin } = usePlugin(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);\n  const context = useTimeSeriesQueryContext();\n\n  const { queryEnabled, queryKey } = getQueryOptions({ plugin, definition, context });\n  return useQuery({\n    enabled: queryEnabled,\n    queryKey: queryKey,\n    queryFn: () => {\n      // The 'enabled' option should prevent this from happening, but make TypeScript happy by checking\n      if (plugin === undefined) {\n        throw new Error('Expected plugin to be loaded');\n      }\n      // Keep options out of query key so we don't re-run queries because suggested step changes\n      const ctx: TimeSeriesQueryContext = { ...context, suggestedStepMs: options?.suggestedStepMs };\n      return plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);\n    },\n  });\n};\n\n/**\n * Runs multiple time series queries using plugins and returns the results.\n */\nexport function useTimeSeriesQueries(definitions: TimeSeriesQueryDefinition[], options?: UseTimeSeriesQueryOptions) {\n  const { getPlugin } = usePluginRegistry();\n  const context = useTimeSeriesQueryContext();\n\n  const pluginLoaderResponse = usePlugins(\n    TIME_SERIES_QUERY_KEY,\n    definitions.map((d) => ({ kind: d.spec.plugin.kind }))\n  );\n\n  return useQueries({\n    queries: definitions.map((definition, idx) => {\n      const plugin = pluginLoaderResponse[idx]?.data;\n      const { queryEnabled, queryKey } = getQueryOptions({ plugin, definition, context });\n      return {\n        enabled: queryEnabled,\n        queryKey: queryKey,\n        queryFn: async () => {\n          // Keep options out of query key so we don't re-run queries because suggested step changes\n          const ctx: TimeSeriesQueryContext = { ...context, suggestedStepMs: options?.suggestedStepMs };\n          const plugin = await getPlugin(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);\n          const data = await plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);\n          return data;\n        },\n      };\n    }),\n  });\n}\n\n/**\n * Build the time series query context object from data available at runtime\n */\nfunction useTimeSeriesQueryContext(): TimeSeriesQueryContext {\n  const { absoluteTimeRange, refreshKey } = useTimeRange();\n  const variableState = useTemplateVariableValues();\n  const datasourceStore = useDatasourceStore();\n\n  return {\n    timeRange: absoluteTimeRange,\n    variableState,\n    datasourceStore,\n    refreshKey,\n  };\n}\n\n/**\n * Get active time series queries for query results summary\n */\nexport function useActiveTimeSeriesQueries() {\n  const queryClient = useQueryClient();\n  const queryCache = queryClient.getQueryCache();\n  return getActiveTimeSeriesQueries(queryCache);\n}\n\n/**\n * Filter all cached queries down to only active time series queries\n */\nexport function getActiveTimeSeriesQueries(cache: QueryCache) {\n  const queries: TimeSeriesDataQuery[] = [];\n\n  for (const query of cache.findAll({ type: 'active' })) {\n    const firstPart = query.queryKey?.[0] as UnknownSpec;\n    if (firstPart?.kind && (firstPart.kind as string).startsWith(TIME_SERIES_QUERY_KEY)) {\n      queries.push(query as Query<TimeSeriesData, unknown, TimeSeriesData, QueryKey>);\n    }\n  }\n\n  return queries;\n}\n"],"names":["useQuery","useQueries","useQueryClient","useTemplateVariableValues","useTimeRange","useDatasourceStore","usePlugin","usePluginRegistry","usePlugins","TIME_SERIES_QUERY_KEY","getVariableValuesKey","v","Object","values","map","JSON","stringify","value","join","filterVariableStateMap","names","fromEntries","entries","filter","name","includes","getQueryOptions","plugin","definition","context","timeRange","datasourceStore","suggestedStepMs","variableState","refreshKey","dependencies","dependsOn","spec","variableDependencies","variables","filteredVariabledState","variablesValueKey","queryKey","waitToLoad","some","loading","queryEnabled","undefined","useTimeSeriesQuery","options","data","kind","useTimeSeriesQueryContext","enabled","queryFn","Error","ctx","getTimeSeriesData","useTimeSeriesQueries","definitions","getPlugin","pluginLoaderResponse","d","queries","idx","absoluteTimeRange","useActiveTimeSeriesQueries","queryClient","queryCache","getQueryCache","getActiveTimeSeriesQueries","cache","query","findAll","type","firstPart","startsWith","push"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SAASA,QAAQ,EAAEC,UAAU,EAAEC,cAAc,QAAqC,uBAAuB,CAAC;AAI1G,SAASC,yBAAyB,QAAQ,sBAAsB,CAAC;AACjE,SAASC,YAAY,QAAQ,qBAAqB,CAAC;AACnD,SAASC,kBAAkB,QAAQ,eAAe,CAAC;AACnD,SAASC,SAAS,EAAEC,iBAAiB,EAAEC,UAAU,QAAQ,mBAAmB,CAAC;AAM7E,OAAO,MAAMC,qBAAqB,GAAG,iBAAiB,CAAC;AAEvD;;CAEC,GACD,SAASC,oBAAoB,CAACC,CAAmB,EAAE;IACjD,OAAOC,MAAM,CAACC,MAAM,CAACF,CAAC,CAAC,CACpBG,GAAG,CAAC,CAACH,CAAC,GAAKI,IAAI,CAACC,SAAS,CAACL,CAAC,CAACM,KAAK,CAAC,CAAC,CACnCC,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,SAASC,sBAAsB,CAACR,CAAmB,EAAES,KAAgB,EAAE;IACrE,IAAI,CAACA,KAAK,EAAE;QACV,OAAOT,CAAC,CAAC;IACX,CAAC;IACD,OAAOC,MAAM,CAACS,WAAW,CAACT,MAAM,CAACU,OAAO,CAACX,CAAC,CAAC,CAACY,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,GAAKJ,KAAK,CAACK,QAAQ,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC;AACxF,CAAC;AAED,SAASE,eAAe,CAAC,EACvBC,MAAM,CAAA,EACNC,UAAU,CAAA,EACVC,OAAO,CAAA,EAKR,EAAE;IACD,MAAM,EAAEC,SAAS,CAAA,EAAEC,eAAe,CAAA,EAAEC,eAAe,CAAA,EAAEC,aAAa,CAAA,EAAEC,UAAU,CAAA,EAAE,GAAGL,OAAO,AAAC;IAE3F,MAAMM,YAAY,GAAGR,CAAAA,MAAM,aAANA,MAAM,WAAW,GAAjBA,KAAAA,CAAiB,GAAjBA,MAAM,CAAES,SAAS,CAAA,GAAGT,MAAM,CAACS,SAAS,CAACR,UAAU,CAACS,IAAI,CAACV,MAAM,CAACU,IAAI,EAAER,OAAO,CAAC,GAAG,EAAE,AAAC;IACrG,MAAMS,oBAAoB,GAAGH,YAAY,aAAZA,YAAY,WAAW,GAAvBA,KAAAA,CAAuB,GAAvBA,YAAY,CAAEI,SAAS,AAAC;IAErD,qBAAqB;IACrB,MAAMC,sBAAsB,GAAGrB,sBAAsB,CAACc,aAAa,EAAEK,oBAAoB,CAAC,AAAC;IAC3F,MAAMG,iBAAiB,GAAG/B,oBAAoB,CAAC8B,sBAAsB,CAAC,AAAC;IACvE,MAAME,QAAQ,GAAG;QAACd,UAAU;QAAEE,SAAS;QAAEC,eAAe;QAAEC,eAAe;QAAES,iBAAiB;QAAEP,UAAU;KAAC,AAAS,AAAC;IAEnH,yBAAyB;IACzB,IAAIS,UAAU,GAAG,KAAK,AAAC;IACvB,IAAIL,oBAAoB,EAAE;QACxBK,UAAU,GAAGL,oBAAoB,CAACM,IAAI,CAAC,CAACjC,CAAC;gBAAKsB,GAAgB;YAAhBA,OAAAA,CAAAA,GAAgB,GAAhBA,aAAa,CAACtB,CAAC,CAAC,cAAhBsB,GAAgB,WAAS,GAAzBA,KAAAA,CAAyB,GAAzBA,GAAgB,CAAEY,OAAO,CAAA;SAAA,CAAC,CAAC;IAC3E,CAAC;IAED,MAAMC,YAAY,GAAGnB,MAAM,KAAKoB,SAAS,IAAI,CAACJ,UAAU,AAAC;IAEzD,OAAO;QACLD,QAAQ;QACRI,YAAY;KACb,CAAC;AACJ,CAAC;AAED;;CAEC,GACD,OAAO,MAAME,kBAAkB,GAAG,CAACpB,UAAqC,EAAEqB,OAAmC,GAAK;IAChH,MAAM,EAAEC,IAAI,EAAEvB,MAAM,CAAA,EAAE,GAAGrB,SAAS,CAACG,qBAAqB,EAAEmB,UAAU,CAACS,IAAI,CAACV,MAAM,CAACwB,IAAI,CAAC,AAAC;IACvF,MAAMtB,OAAO,GAAGuB,yBAAyB,EAAE,AAAC;IAE5C,MAAM,EAAEN,YAAY,CAAA,EAAEJ,QAAQ,CAAA,EAAE,GAAGhB,eAAe,CAAC;QAAEC,MAAM;QAAEC,UAAU;QAAEC,OAAO;KAAE,CAAC,AAAC;IACpF,OAAO7B,QAAQ,CAAC;QACdqD,OAAO,EAAEP,YAAY;QACrBJ,QAAQ,EAAEA,QAAQ;QAClBY,OAAO,EAAE,IAAM;YACb,iGAAiG;YACjG,IAAI3B,MAAM,KAAKoB,SAAS,EAAE;gBACxB,MAAM,IAAIQ,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YACD,0FAA0F;YAC1F,MAAMC,GAAG,GAA2B;gBAAE,GAAG3B,OAAO;gBAAEG,eAAe,EAAEiB,OAAO,aAAPA,OAAO,WAAiB,GAAxBA,KAAAA,CAAwB,GAAxBA,OAAO,CAAEjB,eAAe;aAAE,AAAC;YAC9F,OAAOL,MAAM,CAAC8B,iBAAiB,CAAC7B,UAAU,CAACS,IAAI,CAACV,MAAM,CAACU,IAAI,EAAEmB,GAAG,CAAC,CAAC;QACpE,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;CAEC,GACD,OAAO,SAASE,oBAAoB,CAACC,WAAwC,EAAEV,OAAmC,EAAE;IAClH,MAAM,EAAEW,SAAS,CAAA,EAAE,GAAGrD,iBAAiB,EAAE,AAAC;IAC1C,MAAMsB,OAAO,GAAGuB,yBAAyB,EAAE,AAAC;IAE5C,MAAMS,oBAAoB,GAAGrD,UAAU,CACrCC,qBAAqB,EACrBkD,WAAW,CAAC7C,GAAG,CAAC,CAACgD,CAAC,GAAM,CAAA;YAAEX,IAAI,EAAEW,CAAC,CAACzB,IAAI,CAACV,MAAM,CAACwB,IAAI;SAAE,CAAA,AAAC,CAAC,CACvD,AAAC;IAEF,OAAOlD,UAAU,CAAC;QAChB8D,OAAO,EAAEJ,WAAW,CAAC7C,GAAG,CAAC,CAACc,UAAU,EAAEoC,GAAG,GAAK;gBAC7BH,GAAyB;YAAxC,MAAMlC,MAAM,GAAGkC,CAAAA,GAAyB,GAAzBA,oBAAoB,CAACG,GAAG,CAAC,cAAzBH,GAAyB,WAAM,GAA/BA,KAAAA,CAA+B,GAA/BA,GAAyB,CAAEX,IAAI,AAAC;YAC/C,MAAM,EAAEJ,YAAY,CAAA,EAAEJ,QAAQ,CAAA,EAAE,GAAGhB,eAAe,CAAC;gBAAEC,MAAM;gBAAEC,UAAU;gBAAEC,OAAO;aAAE,CAAC,AAAC;YACpF,OAAO;gBACLwB,OAAO,EAAEP,YAAY;gBACrBJ,QAAQ,EAAEA,QAAQ;gBAClBY,OAAO,EAAE,UAAY;oBACnB,0FAA0F;oBAC1F,MAAME,GAAG,GAA2B;wBAAE,GAAG3B,OAAO;wBAAEG,eAAe,EAAEiB,OAAO,aAAPA,OAAO,WAAiB,GAAxBA,KAAAA,CAAwB,GAAxBA,OAAO,CAAEjB,eAAe;qBAAE,AAAC;oBAC9F,MAAML,MAAM,GAAG,MAAMiC,SAAS,CAACnD,qBAAqB,EAAEmB,UAAU,CAACS,IAAI,CAACV,MAAM,CAACwB,IAAI,CAAC,AAAC;oBACnF,MAAMD,IAAI,GAAG,MAAMvB,MAAM,CAAC8B,iBAAiB,CAAC7B,UAAU,CAACS,IAAI,CAACV,MAAM,CAACU,IAAI,EAAEmB,GAAG,CAAC,AAAC;oBAC9E,OAAON,IAAI,CAAC;gBACd,CAAC;aACF,CAAC;QACJ,CAAC,CAAC;KACH,CAAC,CAAC;AACL,CAAC;AAED;;CAEC,GACD,SAASE,yBAAyB,GAA2B;IAC3D,MAAM,EAAEa,iBAAiB,CAAA,EAAE/B,UAAU,CAAA,EAAE,GAAG9B,YAAY,EAAE,AAAC;IACzD,MAAM6B,aAAa,GAAG9B,yBAAyB,EAAE,AAAC;IAClD,MAAM4B,eAAe,GAAG1B,kBAAkB,EAAE,AAAC;IAE7C,OAAO;QACLyB,SAAS,EAAEmC,iBAAiB;QAC5BhC,aAAa;QACbF,eAAe;QACfG,UAAU;KACX,CAAC;AACJ,CAAC;AAED;;CAEC,GACD,OAAO,SAASgC,0BAA0B,GAAG;IAC3C,MAAMC,WAAW,GAAGjE,cAAc,EAAE,AAAC;IACrC,MAAMkE,UAAU,GAAGD,WAAW,CAACE,aAAa,EAAE,AAAC;IAC/C,OAAOC,0BAA0B,CAACF,UAAU,CAAC,CAAC;AAChD,CAAC;AAED;;CAEC,GACD,OAAO,SAASE,0BAA0B,CAACC,KAAiB,EAAE;IAC5D,MAAMR,OAAO,GAA0B,EAAE,AAAC;IAE1C,KAAK,MAAMS,KAAK,IAAID,KAAK,CAACE,OAAO,CAAC;QAAEC,IAAI,EAAE,QAAQ;KAAE,CAAC,CAAE;YACnCF,GAAc;QAAhC,MAAMG,SAAS,GAAGH,CAAAA,GAAc,GAAdA,KAAK,CAAC9B,QAAQ,cAAd8B,GAAc,WAAK,GAAnBA,KAAAA,CAAmB,GAAnBA,GAAc,AAAE,CAAC,CAAC,CAAC,AAAe,AAAC;QACrD,IAAIG,CAAAA,SAAS,aAATA,SAAS,WAAM,GAAfA,KAAAA,CAAe,GAAfA,SAAS,CAAExB,IAAI,CAAA,IAAI,AAACwB,SAAS,CAACxB,IAAI,CAAYyB,UAAU,CAACnE,qBAAqB,CAAC,EAAE;YACnFsD,OAAO,CAACc,IAAI,CAACL,KAAK,CAA6D,CAAC;QAClF,CAAC;IACH,CAAC;IAED,OAAOT,OAAO,CAAC;AACjB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@perses-dev/plugin-system",
-  "version": "0.23.1",
+  "version": "0.25.0",
   "description": "The plugin feature in Pereses",
   "license": "Apache-2.0",
   "homepage": "https://github.com/perses/perses/blob/main/README.md",
@@ -20,15 +20,16 @@
     "build": "concurrently \"npm:build:*\"",
     "build:cjs": "swc ./src -d dist/cjs --config-file ../.cjs.swcrc",
     "build:esm": "swc ./src -d dist --config-file ../.swcrc",
-    "build:types": "tsc --emitDeclarationOnly --declaration --preserveWatchOutput",
+    "build:types": "tsc --project tsconfig.build.json",
+    "type-check": "tsc --noEmit",
     "start": "concurrently -P \"npm:build:* -- {*}\" -- --watch",
     "test": "TZ=UTC jest",
     "lint": "eslint src --ext .ts,.tsx",
     "lint:fix": "eslint --fix src --ext .ts,.tsx"
   },
   "dependencies": {
-    "@perses-dev/components": "0.23.1",
-    "@perses-dev/core": "0.23.1",
+    "@perses-dev/components": "0.25.0",
+    "@perses-dev/core": "0.25.0",
     "immer": "^9.0.15",
     "use-immer": "^0.7.0",
     "use-query-params": "^2.1.2"

package/dist/cjs/components/CalculationSelector/CalculationSelector.test.js

@@ -1,65 +0,0 @@
-// Copyright 2023 The Perses Authors
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _jsxRuntime = require("react/jsx-runtime");
-const _react = require("@testing-library/react");
-const _userEvent = /*#__PURE__*/ _interopRequireDefault(require("@testing-library/user-event"));
-const _calculationSelector = require("./CalculationSelector");
-function _interopRequireDefault(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-describe('CalculationSelector', ()=>{
-    const renderCalculationSelector = (value, onChange = jest.fn())=>{
-        (0, _react.render)(/*#__PURE__*/ (0, _jsxRuntime.jsx)("div", {
-            children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_calculationSelector.CalculationSelector, {
-                value: value,
-                onChange: onChange
-            })
-        }));
-    };
-    const getCalculationSelector = ()=>{
-        return _react.screen.getByRole('combobox', {
-            name: 'Calculation'
-        });
-    };
-    it('can change the calculation by clicking', ()=>{
-        const onChange = jest.fn();
-        renderCalculationSelector('Last', onChange);
-        const calcSelector = getCalculationSelector();
-        _userEvent.default.click(calcSelector);
-        const sumOption = _react.screen.getByRole('option', {
-            name: 'Sum'
-        });
-        _userEvent.default.click(sumOption);
-        expect(onChange).toHaveBeenCalledWith('Sum');
-    });
-    it('can change the calculation using a keyboard', ()=>{
-        const onChange = jest.fn();
-        renderCalculationSelector('First', onChange);
-        const calcSelector = getCalculationSelector();
-        _userEvent.default.tab();
-        expect(calcSelector).toHaveFocus();
-        _userEvent.default.clear(calcSelector);
-        _userEvent.default.keyboard('first');
-        _react.screen.getByRole('option', {
-            name: 'First'
-        });
-        _userEvent.default.keyboard('{arrowup}{enter}');
-        expect(onChange).toHaveBeenCalledWith('First');
-    });
-});