@perses-dev/plugin-system 0.38.0 → 0.40.0

package/dist/runtime/datasources.js

@@ -21,14 +21,14 @@ export function useDatasourceStore() {
     return ctx;
 }
 /**
- * Lists all available Datasource instances for a given datasource plugin kind. Returns a list with the name of that
- * instance, as well as its DatasourceSelector for referencing it.
- */ export function useListDatasources(datasourcePluginKind) {
-    const { listDatasourceMetadata  } = useDatasourceStore();
+ * Lists all available Datasource selection items for a given datasource plugin kind.
+ * Returns a list, with all information that can be used in a datasource selection context (group, name, selector, kind, ...)
+ */ export function useListDatasourceSelectItems(datasourcePluginKind) {
+    const { listDatasourceSelectItems  } = useDatasourceStore();
     return useQuery([
-        'listDatasourceMetadata',
+        'listDatasourceSelectItems',
         datasourcePluginKind
-    ], ()=>listDatasourceMetadata(datasourcePluginKind));
+    ], ()=>listDatasourceSelectItems(datasourcePluginKind));
 }
 /**
  * Provides a convenience hook for getting a DatasourceClient for a given DatasourceSelector.
@@ -39,5 +39,12 @@ export function useDatasourceStore() {
         selector
     ], ()=>store.getDatasourceClient(selector));
 }
+export function useDatasource(selector) {
+    const store = useDatasourceStore();
+    return useQuery([
+        'getDatasource',
+        selector
+    ], ()=>store.getDatasource(selector));
+}
 
 //# sourceMappingURL=datasources.js.map

package/dist/runtime/datasources.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/runtime/datasources.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 { DatasourceSelector, DatasourceSpec } from '@perses-dev/core';\nimport { useQuery } from '@tanstack/react-query';\nimport { createContext, useContext } from 'react';\n\nexport interface DatasourceStore {\n  // TODO: Do we even need this method?\n  getDatasource(selector: DatasourceSelector): Promise<DatasourceSpec>;\n\n  /**\n   * Given a DatasourceSelector, gets a `Client` object from the corresponding Datasource plugin.\n   */\n  getDatasourceClient<Client>(selector: DatasourceSelector): Promise<Client>;\n\n  /**\n   * Gets a list of datasource metadata for a plugin kind.\n   */\n  listDatasourceMetadata(datasourcePluginKind: string): Promise<DatasourceMetadata[]>;\n}\n\nexport interface DatasourceMetadata {\n  name: string;\n  selector: DatasourceSelector;\n}\n\nexport const DatasourceStoreContext = createContext<DatasourceStore | undefined>(undefined);\n\nexport function useDatasourceStore() {\n  const ctx = useContext(DatasourceStoreContext);\n  if (ctx === undefined) {\n    throw new Error('No DatasourceStoreContext found. Did you forget a Provider?');\n  }\n  return ctx;\n}\n\n/**\n * Lists all available Datasource instances for a given datasource plugin kind. Returns a list with the name of that\n * instance, as well as its DatasourceSelector for referencing it.\n */\nexport function useListDatasources(datasourcePluginKind: string) {\n  const { listDatasourceMetadata } = useDatasourceStore();\n  return useQuery(['listDatasourceMetadata', datasourcePluginKind], () => listDatasourceMetadata(datasourcePluginKind));\n}\n\n/**\n * Provides a convenience hook for getting a DatasourceClient for a given DatasourceSelector.\n */\nexport function useDatasourceClient<Client>(selector: DatasourceSelector) {\n  const store = useDatasourceStore();\n  return useQuery<Client>(['getDatasourceClient', selector], () => store.getDatasourceClient<Client>(selector));\n}\n"],"names":["useQuery","createContext","useContext","DatasourceStoreContext","undefined","useDatasourceStore","ctx","Error","useListDatasources","datasourcePluginKind","listDatasourceMetadata","useDatasourceClient","selector","store","getDatasourceClient"],"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,QAAQ,uBAAuB,CAAC;AACjD,SAASC,aAAa,EAAEC,UAAU,QAAQ,OAAO,CAAC;AAsBlD,OAAO,MAAMC,sBAAsB,GAAGF,aAAa,CAA8BG,SAAS,CAAC,CAAC;AAE5F,OAAO,SAASC,kBAAkB,GAAG;IACnC,MAAMC,GAAG,GAAGJ,UAAU,CAACC,sBAAsB,CAAC,AAAC;IAC/C,IAAIG,GAAG,KAAKF,SAAS,EAAE;QACrB,MAAM,IAAIG,KAAK,CAAC,6DAA6D,CAAC,CAAC;IACjF,CAAC;IACD,OAAOD,GAAG,CAAC;AACb,CAAC;AAED;;;CAGC,GACD,OAAO,SAASE,kBAAkB,CAACC,oBAA4B,EAAE;IAC/D,MAAM,EAAEC,sBAAsB,CAAA,EAAE,GAAGL,kBAAkB,EAAE,AAAC;IACxD,OAAOL,QAAQ,CAAC;QAAC,wBAAwB;QAAES,oBAAoB;KAAC,EAAE,IAAMC,sBAAsB,CAACD,oBAAoB,CAAC,CAAC,CAAC;AACxH,CAAC;AAED;;CAEC,GACD,OAAO,SAASE,mBAAmB,CAASC,QAA4B,EAAE;IACxE,MAAMC,KAAK,GAAGR,kBAAkB,EAAE,AAAC;IACnC,OAAOL,QAAQ,CAAS;QAAC,qBAAqB;QAAEY,QAAQ;KAAC,EAAE,IAAMC,KAAK,CAACC,mBAAmB,CAASF,QAAQ,CAAC,CAAC,CAAC;AAChH,CAAC"}
+{"version":3,"sources":["../../src/runtime/datasources.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 { DatasourceSelector, DatasourceSpec } from '@perses-dev/core';\nimport { useQuery } from '@tanstack/react-query';\nimport { createContext, useContext } from 'react';\n\nexport interface DatasourceStore {\n  // TODO: Do we even need this method?\n  getDatasource(selector: DatasourceSelector): Promise<DatasourceSpec>;\n\n  /**\n   * Given a DatasourceSelector, gets a `Client` object from the corresponding Datasource plugin.\n   */\n  getDatasourceClient<Client>(selector: DatasourceSelector): Promise<Client>;\n\n  /**\n   * Gets a list of datasource selection items for a plugin kind.\n   */\n  listDatasourceSelectItems(datasourcePluginKind: string): Promise<DatasourceSelectItemGroup[]>;\n}\n\nexport interface DatasourceSelectItemGroup {\n  group?: string;\n  editLink?: string;\n  items: DatasourceSelectItem[];\n}\n\nexport interface DatasourceSelectItem {\n  name: string;\n  overridden?: boolean;\n  overriding?: boolean;\n  selector: DatasourceSelector;\n}\n\nexport const DatasourceStoreContext = createContext<DatasourceStore | undefined>(undefined);\n\nexport function useDatasourceStore() {\n  const ctx = useContext(DatasourceStoreContext);\n  if (ctx === undefined) {\n    throw new Error('No DatasourceStoreContext found. Did you forget a Provider?');\n  }\n  return ctx;\n}\n\n/**\n * Lists all available Datasource selection items for a given datasource plugin kind.\n * Returns a list, with all information that can be used in a datasource selection context (group, name, selector, kind, ...)\n */\nexport function useListDatasourceSelectItems(datasourcePluginKind: string) {\n  const { listDatasourceSelectItems } = useDatasourceStore();\n  return useQuery(['listDatasourceSelectItems', datasourcePluginKind], () =>\n    listDatasourceSelectItems(datasourcePluginKind)\n  );\n}\n\n/**\n * Provides a convenience hook for getting a DatasourceClient for a given DatasourceSelector.\n */\nexport function useDatasourceClient<Client>(selector: DatasourceSelector) {\n  const store = useDatasourceStore();\n  return useQuery<Client>(['getDatasourceClient', selector], () => store.getDatasourceClient<Client>(selector));\n}\n\nexport function useDatasource(selector: DatasourceSelector) {\n  const store = useDatasourceStore();\n  return useQuery(['getDatasource', selector], () => store.getDatasource(selector));\n}\n"],"names":["useQuery","createContext","useContext","DatasourceStoreContext","undefined","useDatasourceStore","ctx","Error","useListDatasourceSelectItems","datasourcePluginKind","listDatasourceSelectItems","useDatasourceClient","selector","store","getDatasourceClient","useDatasource","getDatasource"],"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,QAAQ,wBAAwB;AACjD,SAASC,aAAa,EAAEC,UAAU,QAAQ,QAAQ;AA8BlD,OAAO,MAAMC,yBAAyBF,cAA2CG,WAAW;AAE5F,OAAO,SAASC;IACd,MAAMC,MAAMJ,WAAWC;IACvB,IAAIG,QAAQF,WAAW;QACrB,MAAM,IAAIG,MAAM;IAClB;IACA,OAAOD;AACT;AAEA;;;CAGC,GACD,OAAO,SAASE,6BAA6BC,oBAA4B;IACvE,MAAM,EAAEC,0BAAyB,EAAE,GAAGL;IACtC,OAAOL,SAAS;QAAC;QAA6BS;KAAqB,EAAE,IACnEC,0BAA0BD;AAE9B;AAEA;;CAEC,GACD,OAAO,SAASE,oBAA4BC,QAA4B;IACtE,MAAMC,QAAQR;IACd,OAAOL,SAAiB;QAAC;QAAuBY;KAAS,EAAE,IAAMC,MAAMC,oBAA4BF;AACrG;AAEA,OAAO,SAASG,cAAcH,QAA4B;IACxD,MAAMC,QAAQR;IACd,OAAOL,SAAS;QAAC;QAAiBY;KAAS,EAAE,IAAMC,MAAMG,cAAcJ;AACzE"}

package/dist/runtime/index.d.ts

@@ -1,3 +1,4 @@
+export * from './builtin-variables';
 export * from './datasources';
 export * from './plugin-registry';
 export * from './template-variables';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/runtime/index.ts"],"names":[],"mappings":"AAaA,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/runtime/index.ts"],"names":[],"mappings":"AAaA,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC"}

package/dist/runtime/index.js

@@ -10,6 +10,7 @@
 // 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.
+export * from './builtin-variables';
 export * from './datasources';
 export * from './plugin-registry';
 export * from './template-variables';

package/dist/runtime/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/runtime/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 './datasources';\nexport * from './plugin-registry';\nexport * from './template-variables';\nexport * from './TimeRangeProvider';\nexport * from './time-series-queries';\nexport * from './DataQueriesProvider';\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,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC"}
+{"version":3,"sources":["../../src/runtime/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 './builtin-variables';\nexport * from './datasources';\nexport * from './plugin-registry';\nexport * from './template-variables';\nexport * from './TimeRangeProvider';\nexport * from './time-series-queries';\nexport * from './DataQueriesProvider';\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,sBAAsB;AACpC,cAAc,gBAAgB;AAC9B,cAAc,oBAAoB;AAClC,cAAc,uBAAuB;AACrC,cAAc,sBAAsB;AACpC,cAAc,wBAAwB;AACtC,cAAc,wBAAwB"}

package/dist/runtime/plugin-registry.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import { UseQueryOptions } from '@tanstack/react-query';
+import { BuiltinVariableDefinition } from '@perses-dev/core';
 import { DefaultPluginKinds, PluginImplementation, PluginMetadata, PluginType } from '../model';
 export interface PluginRegistryContextType {
     getPlugin<T extends PluginType>(pluginType: T, kind: string): Promise<PluginImplementation<T>>;
@@ -28,5 +29,6 @@ declare type UseListPluginMetadataOptions = Omit<UseQueryOptions<PluginMetadata[
  * Gets a list of plugin metadata for the specified plugin type and returns it, along with loading/error state.
  */
 export declare function useListPluginMetadata(pluginType: PluginType, options?: UseListPluginMetadataOptions): import("@tanstack/react-query").UseQueryResult<PluginMetadata[], Error>;
+export declare function usePluginBuiltinVariableDefinitions(): import("@tanstack/react-query").UseQueryResult<BuiltinVariableDefinition[], unknown>;
 export {};
 //# sourceMappingURL=plugin-registry.d.ts.map

package/dist/runtime/plugin-registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-registry.d.ts","sourceRoot":"","sources":["../../src/runtime/plugin-registry.ts"],"names":[],"mappings":";AAcA,OAAO,EAAwB,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC9E,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEhG,MAAM,WAAW,yBAAyB;IACxC,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/F,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACtE,kBAAkB,EAAE,kBAAkB,CAAC;CACxC;AAED,eAAO,MAAM,qBAAqB,gEAAkE,CAAC;AAErG;;;GAGG;AACH,wBAAgB,iBAAiB,8BAMhC;AAGD,aAAK,gBAAgB,CAAC,CAAC,SAAS,UAAU,IAAI,IAAI,CAChD,eAAe,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,EACtG,UAAU,GAAG,SAAS,CACvB,CAAC;AAEF;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,kFAQzG;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,sFAU/F;AAGD,aAAK,4BAA4B,GAAG,IAAI,CACtC,eAAe,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,EAChF,UAAU,GAAG,SAAS,CACvB,CAAC;AAEF;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,4BAA4B,2EAGnG"}
+{"version":3,"file":"plugin-registry.d.ts","sourceRoot":"","sources":["../../src/runtime/plugin-registry.ts"],"names":[],"mappings":";AAcA,OAAO,EAAwB,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEhG,MAAM,WAAW,yBAAyB;IACxC,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/F,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACtE,kBAAkB,EAAE,kBAAkB,CAAC;CACxC;AAED,eAAO,MAAM,qBAAqB,gEAAkE,CAAC;AAErG;;;GAGG;AACH,wBAAgB,iBAAiB,8BAMhC;AAGD,aAAK,gBAAgB,CAAC,CAAC,SAAS,UAAU,IAAI,IAAI,CAChD,eAAe,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,EACtG,UAAU,GAAG,SAAS,CACvB,CAAC;AAEF;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,kFAQzG;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,sFAU/F;AAGD,aAAK,4BAA4B,GAAG,IAAI,CACtC,eAAe,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,EAChF,UAAU,GAAG,SAAS,CACvB,CAAC;AAEF;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,4BAA4B,2EAGnG;AAED,wBAAgB,mCAAmC,yFAelD"}

package/dist/runtime/plugin-registry.js

@@ -26,11 +26,11 @@ export const PluginRegistryContext = createContext(undefined);
 /**
  * Loads a plugin and returns the plugin implementation, along with loading/error state.
  */ export function usePlugin(pluginType, kind, options) {
-    var ref;
+    var _options_enabled;
     // We never want to ask for a plugin when the kind isn't set yet, so disable those queries automatically
     options = {
         ...options,
-        enabled: ((ref = options === null || options === void 0 ? void 0 : options.enabled) !== null && ref !== void 0 ? ref : true) && kind !== ''
+        enabled: ((_options_enabled = options === null || options === void 0 ? void 0 : options.enabled) !== null && _options_enabled !== void 0 ? _options_enabled : true) && kind !== ''
     };
     const { getPlugin  } = usePluginRegistry();
     return useQuery([
@@ -65,5 +65,22 @@ export const PluginRegistryContext = createContext(undefined);
         pluginType
     ], ()=>listPluginMetadata(pluginType), options);
 }
+export function usePluginBuiltinVariableDefinitions() {
+    const { getPlugin , listPluginMetadata  } = usePluginRegistry();
+    return useQuery([
+        'usePluginBuiltinVariableDefinitions'
+    ], async ()=>{
+        const datasources = await listPluginMetadata('Datasource');
+        const datasourceKinds = new Set(datasources.map((datasource)=>datasource.kind));
+        const result = [];
+        for (const kind of datasourceKinds){
+            const plugin = await getPlugin('Datasource', kind);
+            if (plugin.getBuiltinVariableDefinitions) {
+                plugin.getBuiltinVariableDefinitions().forEach((definition)=>result.push(definition));
+            }
+        }
+        return result;
+    });
+}
 
 //# sourceMappingURL=plugin-registry.js.map

package/dist/runtime/plugin-registry.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/runtime/plugin-registry.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 { createContext, useContext } from 'react';\nimport { useQuery, useQueries, UseQueryOptions } from '@tanstack/react-query';\nimport { DefaultPluginKinds, PluginImplementation, PluginMetadata, PluginType } from '../model';\n\nexport interface PluginRegistryContextType {\n  getPlugin<T extends PluginType>(pluginType: T, kind: string): Promise<PluginImplementation<T>>;\n  listPluginMetadata(pluginType: PluginType): Promise<PluginMetadata[]>;\n  defaultPluginKinds: DefaultPluginKinds;\n}\n\nexport const PluginRegistryContext = createContext<PluginRegistryContextType | undefined>(undefined);\n\n/**\n * Use the PluginRegistry context directly. This is meant as an escape hatch for custom async flows. You should probably\n * be using `usePlugin` or `useListPluginMetadata` instead.\n */\nexport function usePluginRegistry() {\n  const ctx = useContext(PluginRegistryContext);\n  if (ctx === undefined) {\n    throw new Error('PluginRegistryContext not found. Did you forget a provider?');\n  }\n  return ctx;\n}\n\n// Allows consumers to pass useQuery options from react-query when loading a plugin\ntype UsePluginOptions<T extends PluginType> = Omit<\n  UseQueryOptions<PluginImplementation<T>, Error, PluginImplementation<T>, [string, PluginType, string]>,\n  'queryKey' | 'queryFn'\n>;\n\n/**\n * Loads a plugin and returns the plugin implementation, along with loading/error state.\n */\nexport function usePlugin<T extends PluginType>(pluginType: T, kind: string, options?: UsePluginOptions<T>) {\n  // We never want to ask for a plugin when the kind isn't set yet, so disable those queries automatically\n  options = {\n    ...options,\n    enabled: (options?.enabled ?? true) && kind !== '',\n  };\n  const { getPlugin } = usePluginRegistry();\n  return useQuery(['getPlugin', pluginType, kind], () => getPlugin(pluginType, kind), options);\n}\n\n/**\n * Loads a list of plugins and returns the plugin implementation, along with loading/error state.\n */\nexport function usePlugins<T extends PluginType>(pluginType: T, plugins: Array<{ kind: string }>) {\n  const { getPlugin } = usePluginRegistry();\n  return useQueries({\n    queries: plugins.map((p) => {\n      return {\n        queryKey: ['getPlugin', pluginType, p.kind],\n        queryFn: () => getPlugin(pluginType, p.kind),\n      };\n    }),\n  });\n}\n\n// Allow consumers to pass useQuery options from react-query when listing metadata\ntype UseListPluginMetadataOptions = Omit<\n  UseQueryOptions<PluginMetadata[], Error, PluginMetadata[], [string, PluginType]>,\n  'queryKey' | 'queryFn'\n>;\n\n/**\n * Gets a list of plugin metadata for the specified plugin type and returns it, along with loading/error state.\n */\nexport function useListPluginMetadata(pluginType: PluginType, options?: UseListPluginMetadataOptions) {\n  const { listPluginMetadata } = usePluginRegistry();\n  return useQuery(['listPluginMetadata', pluginType], () => listPluginMetadata(pluginType), options);\n}\n"],"names":["createContext","useContext","useQuery","useQueries","PluginRegistryContext","undefined","usePluginRegistry","ctx","Error","usePlugin","pluginType","kind","options","enabled","getPlugin","usePlugins","plugins","queries","map","p","queryKey","queryFn","useListPluginMetadata","listPluginMetadata"],"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,aAAa,EAAEC,UAAU,QAAQ,OAAO,CAAC;AAClD,SAASC,QAAQ,EAAEC,UAAU,QAAyB,uBAAuB,CAAC;AAS9E,OAAO,MAAMC,qBAAqB,GAAGJ,aAAa,CAAwCK,SAAS,CAAC,CAAC;AAErG;;;CAGC,GACD,OAAO,SAASC,iBAAiB,GAAG;IAClC,MAAMC,GAAG,GAAGN,UAAU,CAACG,qBAAqB,CAAC,AAAC;IAC9C,IAAIG,GAAG,KAAKF,SAAS,EAAE;QACrB,MAAM,IAAIG,KAAK,CAAC,6DAA6D,CAAC,CAAC;IACjF,CAAC;IACD,OAAOD,GAAG,CAAC;AACb,CAAC;AAQD;;CAEC,GACD,OAAO,SAASE,SAAS,CAAuBC,UAAa,EAAEC,IAAY,EAAEC,OAA6B,EAAE;QAI9FA,GAAgB;IAH5B,wGAAwG;IACxGA,OAAO,GAAG;QACR,GAAGA,OAAO;QACVC,OAAO,EAAE,AAACD,CAAAA,CAAAA,GAAgB,GAAhBA,OAAO,aAAPA,OAAO,WAAS,GAAhBA,KAAAA,CAAgB,GAAhBA,OAAO,CAAEC,OAAO,cAAhBD,GAAgB,cAAhBA,GAAgB,GAAI,IAAI,CAAA,IAAKD,IAAI,KAAK,EAAE;KACnD,CAAC;IACF,MAAM,EAAEG,SAAS,CAAA,EAAE,GAAGR,iBAAiB,EAAE,AAAC;IAC1C,OAAOJ,QAAQ,CAAC;QAAC,WAAW;QAAEQ,UAAU;QAAEC,IAAI;KAAC,EAAE,IAAMG,SAAS,CAACJ,UAAU,EAAEC,IAAI,CAAC,EAAEC,OAAO,CAAC,CAAC;AAC/F,CAAC;AAED;;CAEC,GACD,OAAO,SAASG,UAAU,CAAuBL,UAAa,EAAEM,OAAgC,EAAE;IAChG,MAAM,EAAEF,SAAS,CAAA,EAAE,GAAGR,iBAAiB,EAAE,AAAC;IAC1C,OAAOH,UAAU,CAAC;QAChBc,OAAO,EAAED,OAAO,CAACE,GAAG,CAAC,CAACC,CAAC,GAAK;YAC1B,OAAO;gBACLC,QAAQ,EAAE;oBAAC,WAAW;oBAAEV,UAAU;oBAAES,CAAC,CAACR,IAAI;iBAAC;gBAC3CU,OAAO,EAAE,IAAMP,SAAS,CAACJ,UAAU,EAAES,CAAC,CAACR,IAAI,CAAC;aAC7C,CAAC;QACJ,CAAC,CAAC;KACH,CAAC,CAAC;AACL,CAAC;AAQD;;CAEC,GACD,OAAO,SAASW,qBAAqB,CAACZ,UAAsB,EAAEE,OAAsC,EAAE;IACpG,MAAM,EAAEW,kBAAkB,CAAA,EAAE,GAAGjB,iBAAiB,EAAE,AAAC;IACnD,OAAOJ,QAAQ,CAAC;QAAC,oBAAoB;QAAEQ,UAAU;KAAC,EAAE,IAAMa,kBAAkB,CAACb,UAAU,CAAC,EAAEE,OAAO,CAAC,CAAC;AACrG,CAAC"}
+{"version":3,"sources":["../../src/runtime/plugin-registry.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 { createContext, useContext } from 'react';\nimport { useQuery, useQueries, UseQueryOptions } from '@tanstack/react-query';\nimport { BuiltinVariableDefinition } from '@perses-dev/core';\nimport { DefaultPluginKinds, PluginImplementation, PluginMetadata, PluginType } from '../model';\n\nexport interface PluginRegistryContextType {\n  getPlugin<T extends PluginType>(pluginType: T, kind: string): Promise<PluginImplementation<T>>;\n  listPluginMetadata(pluginType: PluginType): Promise<PluginMetadata[]>;\n  defaultPluginKinds: DefaultPluginKinds;\n}\n\nexport const PluginRegistryContext = createContext<PluginRegistryContextType | undefined>(undefined);\n\n/**\n * Use the PluginRegistry context directly. This is meant as an escape hatch for custom async flows. You should probably\n * be using `usePlugin` or `useListPluginMetadata` instead.\n */\nexport function usePluginRegistry() {\n  const ctx = useContext(PluginRegistryContext);\n  if (ctx === undefined) {\n    throw new Error('PluginRegistryContext not found. Did you forget a provider?');\n  }\n  return ctx;\n}\n\n// Allows consumers to pass useQuery options from react-query when loading a plugin\ntype UsePluginOptions<T extends PluginType> = Omit<\n  UseQueryOptions<PluginImplementation<T>, Error, PluginImplementation<T>, [string, PluginType, string]>,\n  'queryKey' | 'queryFn'\n>;\n\n/**\n * Loads a plugin and returns the plugin implementation, along with loading/error state.\n */\nexport function usePlugin<T extends PluginType>(pluginType: T, kind: string, options?: UsePluginOptions<T>) {\n  // We never want to ask for a plugin when the kind isn't set yet, so disable those queries automatically\n  options = {\n    ...options,\n    enabled: (options?.enabled ?? true) && kind !== '',\n  };\n  const { getPlugin } = usePluginRegistry();\n  return useQuery(['getPlugin', pluginType, kind], () => getPlugin(pluginType, kind), options);\n}\n\n/**\n * Loads a list of plugins and returns the plugin implementation, along with loading/error state.\n */\nexport function usePlugins<T extends PluginType>(pluginType: T, plugins: Array<{ kind: string }>) {\n  const { getPlugin } = usePluginRegistry();\n  return useQueries({\n    queries: plugins.map((p) => {\n      return {\n        queryKey: ['getPlugin', pluginType, p.kind],\n        queryFn: () => getPlugin(pluginType, p.kind),\n      };\n    }),\n  });\n}\n\n// Allow consumers to pass useQuery options from react-query when listing metadata\ntype UseListPluginMetadataOptions = Omit<\n  UseQueryOptions<PluginMetadata[], Error, PluginMetadata[], [string, PluginType]>,\n  'queryKey' | 'queryFn'\n>;\n\n/**\n * Gets a list of plugin metadata for the specified plugin type and returns it, along with loading/error state.\n */\nexport function useListPluginMetadata(pluginType: PluginType, options?: UseListPluginMetadataOptions) {\n  const { listPluginMetadata } = usePluginRegistry();\n  return useQuery(['listPluginMetadata', pluginType], () => listPluginMetadata(pluginType), options);\n}\n\nexport function usePluginBuiltinVariableDefinitions() {\n  const { getPlugin, listPluginMetadata } = usePluginRegistry();\n\n  return useQuery(['usePluginBuiltinVariableDefinitions'], async () => {\n    const datasources = await listPluginMetadata('Datasource');\n    const datasourceKinds = new Set(datasources.map((datasource) => datasource.kind));\n    const result: BuiltinVariableDefinition[] = [];\n    for (const kind of datasourceKinds) {\n      const plugin = await getPlugin('Datasource', kind);\n      if (plugin.getBuiltinVariableDefinitions) {\n        plugin.getBuiltinVariableDefinitions().forEach((definition) => result.push(definition));\n      }\n    }\n    return result;\n  });\n}\n"],"names":["createContext","useContext","useQuery","useQueries","PluginRegistryContext","undefined","usePluginRegistry","ctx","Error","usePlugin","pluginType","kind","options","enabled","getPlugin","usePlugins","plugins","queries","map","p","queryKey","queryFn","useListPluginMetadata","listPluginMetadata","usePluginBuiltinVariableDefinitions","datasources","datasourceKinds","Set","datasource","result","plugin","getBuiltinVariableDefinitions","forEach","definition","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,aAAa,EAAEC,UAAU,QAAQ,QAAQ;AAClD,SAASC,QAAQ,EAAEC,UAAU,QAAyB,wBAAwB;AAU9E,OAAO,MAAMC,wBAAwBJ,cAAqDK,WAAW;AAErG;;;CAGC,GACD,OAAO,SAASC;IACd,MAAMC,MAAMN,WAAWG;IACvB,IAAIG,QAAQF,WAAW;QACrB,MAAM,IAAIG,MAAM;IAClB;IACA,OAAOD;AACT;AAQA;;CAEC,GACD,OAAO,SAASE,UAAgCC,UAAa,EAAEC,IAAY,EAAEC,OAA6B;QAI5FA;IAHZ,wGAAwG;IACxGA,UAAU;QACR,GAAGA,OAAO;QACVC,SAAS,AAACD,CAAAA,CAAAA,mBAAAA,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASC,qBAATD,8BAAAA,mBAAoB,IAAG,KAAMD,SAAS;IAClD;IACA,MAAM,EAAEG,UAAS,EAAE,GAAGR;IACtB,OAAOJ,SAAS;QAAC;QAAaQ;QAAYC;KAAK,EAAE,IAAMG,UAAUJ,YAAYC,OAAOC;AACtF;AAEA;;CAEC,GACD,OAAO,SAASG,WAAiCL,UAAa,EAAEM,OAAgC;IAC9F,MAAM,EAAEF,UAAS,EAAE,GAAGR;IACtB,OAAOH,WAAW;QAChBc,SAASD,QAAQE,IAAI,CAACC;YACpB,OAAO;gBACLC,UAAU;oBAAC;oBAAaV;oBAAYS,EAAER;iBAAK;gBAC3CU,SAAS,IAAMP,UAAUJ,YAAYS,EAAER;YACzC;QACF;IACF;AACF;AAQA;;CAEC,GACD,OAAO,SAASW,sBAAsBZ,UAAsB,EAAEE,OAAsC;IAClG,MAAM,EAAEW,mBAAkB,EAAE,GAAGjB;IAC/B,OAAOJ,SAAS;QAAC;QAAsBQ;KAAW,EAAE,IAAMa,mBAAmBb,aAAaE;AAC5F;AAEA,OAAO,SAASY;IACd,MAAM,EAAEV,UAAS,EAAES,mBAAkB,EAAE,GAAGjB;IAE1C,OAAOJ,SAAS;QAAC;KAAsC,EAAE;QACvD,MAAMuB,cAAc,MAAMF,mBAAmB;QAC7C,MAAMG,kBAAkB,IAAIC,IAAIF,YAAYP,IAAI,CAACU,aAAeA,WAAWjB;QAC3E,MAAMkB,SAAsC,EAAE;QAC9C,KAAK,MAAMlB,QAAQe,gBAAiB;YAClC,MAAMI,SAAS,MAAMhB,UAAU,cAAcH;YAC7C,IAAImB,OAAOC,+BAA+B;gBACxCD,OAAOC,gCAAgCC,QAAQ,CAACC,aAAeJ,OAAOK,KAAKD;YAC7E;QACF;QACA,OAAOJ;IACT;AACF"}

package/dist/runtime/template-variables.d.ts

@@ -1,17 +1,77 @@
 /// <reference types="react" />
-import { VariableName, VariableValue } from '@perses-dev/core';
+import { VariableValue } from '@perses-dev/core';
+import { immerable } from 'immer';
 import { VariableOption } from '../model';
 export declare type VariableState = {
     value: VariableValue;
     options?: VariableOption[];
     loading: boolean;
     error?: Error;
+    /**
+     * If a local variable is overriding an external variable, local var will have the flag ``overriding=true``.
+     */
+    overriding?: boolean;
+    /**
+     * If a local variable is overriding an external variable, external var will have the flag ``overridden=true``.
+     */
+    overridden?: boolean;
+    defaultValue?: VariableValue;
 };
-export declare type VariableStateMap = Record<VariableName, VariableState>;
+export declare type VariableStateMap = Record<string, VariableState>;
+/**
+ * Structure used as key in the {@link VariableStoreStateMap}.
+ */
+export declare type VariableStateKey = {
+    /**
+     * name of the variable we want to access in the state.
+     */
+    name: string;
+    /**
+     * source of the variable we want to access in the state.
+     * Defined only for external variables.
+     */
+    source?: string;
+};
+/**
+ * A state map with two entry keys, materialized by {@link VariableStateKey} structure.
+ */
+export declare class VariableStoreStateMap {
+    /**
+     * "Immerable" is mandatory to be able to use this class in an immer context.
+     * Ref: https://docs.pmnd.rs/zustand/integrations/immer-middleware#gotchas
+     */
+    [immerable]: boolean;
+    private readonly DEFAULT_LOCAL_SOURCE_NAME;
+    private readonly _state;
+    /**
+     * Get variable state by key.
+     * @param key
+     */
+    get(key: VariableStateKey): VariableState | undefined;
+    /**
+     * Set variable state by key.
+     * @param key
+     * @param value
+     */
+    set(key: VariableStateKey, value: VariableState): VariableState | undefined;
+    /**
+     * Check presence of variable state by key.
+     * @param key
+     */
+    has(key: VariableStateKey): boolean;
+    /**
+     * Delete variable state by key.
+     * @param key
+     */
+    delete(key: VariableStateKey): boolean;
+    private _sourceName;
+    private _sourceStatesOrEmpty;
+}
 export declare type TemplateVariableSrv = {
     state: VariableStateMap;
 };
 export declare const TemplateVariableContext: import("react").Context<TemplateVariableSrv | undefined>;
 export declare function useTemplateVariableValues(names?: string[]): VariableStateMap;
+export declare function useVariableValues(names?: string[]): VariableStateMap;
 export declare function useReplaceVariablesInString(str: string | undefined): string | undefined;
 //# sourceMappingURL=template-variables.d.ts.map

package/dist/runtime/template-variables.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"template-variables.d.ts","sourceRoot":"","sources":["../../src/runtime/template-variables.ts"],"names":[],"mappings":";AAcA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAG1C,oBAAY,aAAa,GAAG;IAC1B,KAAK,EAAE,aAAa,CAAC;IACrB,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,oBAAY,gBAAgB,GAAG,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;AAEnE,oBAAY,mBAAmB,GAAG;IAChC,KAAK,EAAE,gBAAgB,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,uBAAuB,0DAA4D,CAAC;AAUjG,wBAAgB,yBAAyB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,oBAmBzD;AAGD,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAKvF"}
+{"version":3,"file":"template-variables.d.ts","sourceRoot":"","sources":["../../src/runtime/template-variables.ts"],"names":[],"mappings":";AAcA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAI1C,oBAAY,aAAa,GAAG;IAC1B,KAAK,EAAE,aAAa,CAAC;IACrB,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,oBAAY,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAE7D;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,qBAAa,qBAAqB;IAChC;;;OAGG;IACH,CAAC,SAAS,CAAC,UAAQ;IAEnB,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAM;IAChD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqD;IAE5E;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,gBAAgB,GAAG,aAAa,GAAG,SAAS;IAIrD;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,aAAa,GAAG,aAAa,GAAG,SAAS;IAS3E;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO;IAInC;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO;IAiBtC,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,oBAAoB;CAG7B;AAED,oBAAY,mBAAmB,GAAG;IAChC,KAAK,EAAE,gBAAgB,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,uBAAuB,0DAA4D,CAAC;AAUjG,wBAAgB,yBAAyB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAmB5E;AAED,wBAAgB,iBAAiB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAKpE;AAGD,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAKvF"}

package/dist/runtime/template-variables.js

@@ -10,8 +10,85 @@
 // 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.
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
 import { createContext, useContext, useMemo } from 'react';
+import { immerable } from 'immer';
 import { parseTemplateVariables, replaceTemplateVariables } from '../utils';
+import { useBuiltinVariableValues } from './builtin-variables';
+let _immerable = immerable;
+/**
+ * A state map with two entry keys, materialized by {@link VariableStateKey} structure.
+ */ export class VariableStoreStateMap {
+    /**
+   * Get variable state by key.
+   * @param key
+   */ get(key) {
+        return this._sourceStatesOrEmpty(key.source)[key.name];
+    }
+    /**
+   * Set variable state by key.
+   * @param key
+   * @param value
+   */ set(key, value) {
+        const sourceName = this._sourceName(key.source);
+        if (!this._state[sourceName]) {
+            this._state[sourceName] = {};
+        }
+        this._sourceStatesOrEmpty(key.source)[key.name] = value;
+        return value;
+    }
+    /**
+   * Check presence of variable state by key.
+   * @param key
+   */ has(key) {
+        return this._sourceStatesOrEmpty(key.source)[key.name] !== undefined;
+    }
+    /**
+   * Delete variable state by key.
+   * @param key
+   */ delete(key) {
+        var _Object_keys;
+        const result = this.has(key);
+        const sourceName = this._sourceName(key.source);
+        const sourceStates = this._state[sourceName];
+        // Delete var from source state
+        if (sourceStates) {
+            delete sourceStates[key.name];
+        }
+        // Delete source state from state if empty
+        if (((_Object_keys = Object.keys(sourceStates !== null && sourceStates !== void 0 ? sourceStates : {})) === null || _Object_keys === void 0 ? void 0 : _Object_keys.length) === 0) {
+            delete this._state[sourceName];
+        }
+        return result;
+    }
+    _sourceName(source) {
+        return source !== null && source !== void 0 ? source : this.DEFAULT_LOCAL_SOURCE_NAME;
+    }
+    _sourceStatesOrEmpty(source) {
+        var _this__state_this__sourceName;
+        return (_this__state_this__sourceName = this._state[this._sourceName(source)]) !== null && _this__state_this__sourceName !== void 0 ? _this__state_this__sourceName : {};
+    }
+    constructor(){
+        /**
+   * "Immerable" is mandatory to be able to use this class in an immer context.
+   * Ref: https://docs.pmnd.rs/zustand/integrations/immer-middleware#gotchas
+   */ _define_property(this, _immerable, true);
+        _define_property(this, "DEFAULT_LOCAL_SOURCE_NAME", '');
+        _define_property(this, "_state", {});
+    }
+}
 export const TemplateVariableContext = createContext(undefined);
 function useTemplateVariableContext() {
     const ctx = useContext(TemplateVariableContext);
@@ -40,10 +117,15 @@ export function useTemplateVariableValues(names) {
     }
     return values;
 }
+export function useVariableValues(names) {
+    const templateVariableValues = useTemplateVariableValues(names);
+    const builtinVariableValues = useBuiltinVariableValues(names);
+    return Object.assign(templateVariableValues, builtinVariableValues);
+}
 // Convenience hook for replacing template variables in a string
 export function useReplaceVariablesInString(str) {
     const variablesInString = str ? parseTemplateVariables(str) : [];
-    const variableValues = useTemplateVariableValues(variablesInString);
+    const variableValues = useVariableValues(variablesInString);
     if (!str) return undefined;
     return replaceTemplateVariables(str, variableValues);
 }

package/dist/runtime/template-variables.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/runtime/template-variables.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 { createContext, useContext, useMemo } from 'react';\nimport { VariableName, VariableValue } from '@perses-dev/core';\nimport { VariableOption } from '../model';\nimport { parseTemplateVariables, replaceTemplateVariables } from '../utils';\n\nexport type VariableState = {\n  value: VariableValue;\n  options?: VariableOption[];\n  loading: boolean;\n  error?: Error;\n};\n\nexport type VariableStateMap = Record<VariableName, VariableState>;\n\nexport type TemplateVariableSrv = {\n  state: VariableStateMap;\n};\n\nexport const TemplateVariableContext = createContext<TemplateVariableSrv | undefined>(undefined);\n\nfunction useTemplateVariableContext() {\n  const ctx = useContext(TemplateVariableContext);\n  if (ctx === undefined) {\n    throw new Error('No TemplateVariableContext found. Did you forget a Provider?');\n  }\n  return ctx;\n}\n\nexport function useTemplateVariableValues(names?: string[]) {\n  const { state } = useTemplateVariableContext();\n\n  const values = useMemo(() => {\n    const values: VariableStateMap = {};\n    names?.forEach((name) => {\n      const s = state[name];\n      if (s) {\n        values[name] = s;\n      }\n    });\n    return values;\n  }, [state, names]);\n\n  if (names === undefined) {\n    return state;\n  }\n\n  return values;\n}\n\n// Convenience hook for replacing template variables in a string\nexport function useReplaceVariablesInString(str: string | undefined): string | undefined {\n  const variablesInString = str ? parseTemplateVariables(str) : [];\n  const variableValues = useTemplateVariableValues(variablesInString);\n  if (!str) return undefined;\n  return replaceTemplateVariables(str, variableValues);\n}\n"],"names":["createContext","useContext","useMemo","parseTemplateVariables","replaceTemplateVariables","TemplateVariableContext","undefined","useTemplateVariableContext","ctx","Error","useTemplateVariableValues","names","state","values","forEach","name","s","useReplaceVariablesInString","str","variablesInString","variableValues"],"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,aAAa,EAAEC,UAAU,EAAEC,OAAO,QAAQ,OAAO,CAAC;AAG3D,SAASC,sBAAsB,EAAEC,wBAAwB,QAAQ,UAAU,CAAC;AAe5E,OAAO,MAAMC,uBAAuB,GAAGL,aAAa,CAAkCM,SAAS,CAAC,CAAC;AAEjG,SAASC,0BAA0B,GAAG;IACpC,MAAMC,GAAG,GAAGP,UAAU,CAACI,uBAAuB,CAAC,AAAC;IAChD,IAAIG,GAAG,KAAKF,SAAS,EAAE;QACrB,MAAM,IAAIG,KAAK,CAAC,8DAA8D,CAAC,CAAC;IAClF,CAAC;IACD,OAAOD,GAAG,CAAC;AACb,CAAC;AAED,OAAO,SAASE,yBAAyB,CAACC,KAAgB,EAAE;IAC1D,MAAM,EAAEC,KAAK,CAAA,EAAE,GAAGL,0BAA0B,EAAE,AAAC;IAE/C,MAAMM,MAAM,GAAGX,OAAO,CAAC,IAAM;QAC3B,MAAMW,MAAM,GAAqB,EAAE,AAAC;QACpCF,KAAK,aAALA,KAAK,WAAS,GAAdA,KAAAA,CAAc,GAAdA,KAAK,CAAEG,OAAO,CAAC,CAACC,IAAI,GAAK;YACvB,MAAMC,CAAC,GAAGJ,KAAK,CAACG,IAAI,CAAC,AAAC;YACtB,IAAIC,CAAC,EAAE;gBACLH,MAAM,CAACE,IAAI,CAAC,GAAGC,CAAC,CAAC;YACnB,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAOH,MAAM,CAAC;IAChB,CAAC,EAAE;QAACD,KAAK;QAAED,KAAK;KAAC,CAAC,AAAC;IAEnB,IAAIA,KAAK,KAAKL,SAAS,EAAE;QACvB,OAAOM,KAAK,CAAC;IACf,CAAC;IAED,OAAOC,MAAM,CAAC;AAChB,CAAC;AAED,gEAAgE;AAChE,OAAO,SAASI,2BAA2B,CAACC,GAAuB,EAAsB;IACvF,MAAMC,iBAAiB,GAAGD,GAAG,GAAGf,sBAAsB,CAACe,GAAG,CAAC,GAAG,EAAE,AAAC;IACjE,MAAME,cAAc,GAAGV,yBAAyB,CAACS,iBAAiB,CAAC,AAAC;IACpE,IAAI,CAACD,GAAG,EAAE,OAAOZ,SAAS,CAAC;IAC3B,OAAOF,wBAAwB,CAACc,GAAG,EAAEE,cAAc,CAAC,CAAC;AACvD,CAAC"}
+{"version":3,"sources":["../../src/runtime/template-variables.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 { createContext, useContext, useMemo } from 'react';\nimport { VariableValue } from '@perses-dev/core';\nimport { immerable } from 'immer';\nimport { VariableOption } from '../model';\nimport { parseTemplateVariables, replaceTemplateVariables } from '../utils';\nimport { useBuiltinVariableValues } from './builtin-variables';\n\nexport type VariableState = {\n  value: VariableValue;\n  options?: VariableOption[];\n  loading: boolean;\n  error?: Error;\n  /**\n   * If a local variable is overriding an external variable, local var will have the flag ``overriding=true``.\n   */\n  overriding?: boolean;\n  /**\n   * If a local variable is overriding an external variable, external var will have the flag ``overridden=true``.\n   */\n  overridden?: boolean;\n  defaultValue?: VariableValue;\n};\n\nexport type VariableStateMap = Record<string, VariableState>;\n\n/**\n * Structure used as key in the {@link VariableStoreStateMap}.\n */\nexport type VariableStateKey = {\n  /**\n   * name of the variable we want to access in the state.\n   */\n  name: string;\n  /**\n   * source of the variable we want to access in the state.\n   * Defined only for external variables.\n   */\n  source?: string;\n};\n\n/**\n * A state map with two entry keys, materialized by {@link VariableStateKey} structure.\n */\nexport class VariableStoreStateMap {\n  /**\n   * \"Immerable\" is mandatory to be able to use this class in an immer context.\n   * Ref: https://docs.pmnd.rs/zustand/integrations/immer-middleware#gotchas\n   */\n  [immerable] = true;\n\n  private readonly DEFAULT_LOCAL_SOURCE_NAME = '';\n  private readonly _state: Record<string, Record<string, VariableState>> = {};\n\n  /**\n   * Get variable state by key.\n   * @param key\n   */\n  get(key: VariableStateKey): VariableState | undefined {\n    return this._sourceStatesOrEmpty(key.source)[key.name];\n  }\n\n  /**\n   * Set variable state by key.\n   * @param key\n   * @param value\n   */\n  set(key: VariableStateKey, value: VariableState): VariableState | undefined {\n    const sourceName = this._sourceName(key.source);\n    if (!this._state[sourceName]) {\n      this._state[sourceName] = {};\n    }\n    this._sourceStatesOrEmpty(key.source)[key.name] = value;\n    return value;\n  }\n\n  /**\n   * Check presence of variable state by key.\n   * @param key\n   */\n  has(key: VariableStateKey): boolean {\n    return this._sourceStatesOrEmpty(key.source)[key.name] !== undefined;\n  }\n\n  /**\n   * Delete variable state by key.\n   * @param key\n   */\n  delete(key: VariableStateKey): boolean {\n    const result = this.has(key);\n    const sourceName = this._sourceName(key.source);\n    const sourceStates = this._state[sourceName];\n\n    // Delete var from source state\n    if (sourceStates) {\n      delete sourceStates[key.name];\n    }\n\n    // Delete source state from state if empty\n    if (Object.keys(sourceStates ?? {})?.length === 0) {\n      delete this._state[sourceName];\n    }\n    return result;\n  }\n\n  private _sourceName(source: string | undefined): string {\n    return source ?? this.DEFAULT_LOCAL_SOURCE_NAME;\n  }\n\n  private _sourceStatesOrEmpty(source: string | undefined): Record<string, VariableState> {\n    return this._state[this._sourceName(source)] ?? {};\n  }\n}\n\nexport type TemplateVariableSrv = {\n  state: VariableStateMap;\n};\n\nexport const TemplateVariableContext = createContext<TemplateVariableSrv | undefined>(undefined);\n\nfunction useTemplateVariableContext() {\n  const ctx = useContext(TemplateVariableContext);\n  if (ctx === undefined) {\n    throw new Error('No TemplateVariableContext found. Did you forget a Provider?');\n  }\n  return ctx;\n}\n\nexport function useTemplateVariableValues(names?: string[]): VariableStateMap {\n  const { state } = useTemplateVariableContext();\n\n  const values = useMemo(() => {\n    const values: VariableStateMap = {};\n    names?.forEach((name) => {\n      const s = state[name];\n      if (s) {\n        values[name] = s;\n      }\n    });\n    return values;\n  }, [state, names]);\n\n  if (names === undefined) {\n    return state;\n  }\n\n  return values;\n}\n\nexport function useVariableValues(names?: string[]): VariableStateMap {\n  const templateVariableValues = useTemplateVariableValues(names);\n  const builtinVariableValues = useBuiltinVariableValues(names);\n\n  return Object.assign(templateVariableValues, builtinVariableValues);\n}\n\n// Convenience hook for replacing template variables in a string\nexport function useReplaceVariablesInString(str: string | undefined): string | undefined {\n  const variablesInString = str ? parseTemplateVariables(str) : [];\n  const variableValues = useVariableValues(variablesInString);\n  if (!str) return undefined;\n  return replaceTemplateVariables(str, variableValues);\n}\n"],"names":["createContext","useContext","useMemo","immerable","parseTemplateVariables","replaceTemplateVariables","useBuiltinVariableValues","VariableStoreStateMap","get","key","_sourceStatesOrEmpty","source","name","set","value","sourceName","_sourceName","_state","has","undefined","delete","Object","result","sourceStates","keys","length","DEFAULT_LOCAL_SOURCE_NAME","TemplateVariableContext","useTemplateVariableContext","ctx","Error","useTemplateVariableValues","names","state","values","forEach","s","useVariableValues","templateVariableValues","builtinVariableValues","assign","useReplaceVariablesInString","str","variablesInString","variableValues"],"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,aAAa,EAAEC,UAAU,EAAEC,OAAO,QAAQ,QAAQ;AAE3D,SAASC,SAAS,QAAQ,QAAQ;AAElC,SAASC,sBAAsB,EAAEC,wBAAwB,QAAQ,WAAW;AAC5E,SAASC,wBAAwB,QAAQ,sBAAsB;IA2C5DH,aAAAA;AARH;;CAEC,GACD,OAAO,MAAMI;IAUX;;;GAGC,GACDC,IAAIC,GAAqB,EAA6B;QACpD,OAAO,IAAI,CAACC,qBAAqBD,IAAIE,OAAO,CAACF,IAAIG,KAAK;IACxD;IAEA;;;;GAIC,GACDC,IAAIJ,GAAqB,EAAEK,KAAoB,EAA6B;QAC1E,MAAMC,aAAa,IAAI,CAACC,YAAYP,IAAIE;QACxC,IAAI,CAAC,IAAI,CAACM,MAAM,CAACF,WAAW,EAAE;YAC5B,IAAI,CAACE,MAAM,CAACF,WAAW,GAAG,CAAC;QAC7B;QACA,IAAI,CAACL,qBAAqBD,IAAIE,OAAO,CAACF,IAAIG,KAAK,GAAGE;QAClD,OAAOA;IACT;IAEA;;;GAGC,GACDI,IAAIT,GAAqB,EAAW;QAClC,OAAO,IAAI,CAACC,qBAAqBD,IAAIE,OAAO,CAACF,IAAIG,KAAK,KAAKO;IAC7D;IAEA;;;GAGC,GACDC,OAAOX,GAAqB,EAAW;YAWjCY;QAVJ,MAAMC,SAAS,IAAI,CAACJ,IAAIT;QACxB,MAAMM,aAAa,IAAI,CAACC,YAAYP,IAAIE;QACxC,MAAMY,eAAe,IAAI,CAACN,MAAM,CAACF,WAAW;QAE5C,+BAA+B;QAC/B,IAAIQ,cAAc;YAChB,OAAOA,YAAY,CAACd,IAAIG,KAAK;QAC/B;QAEA,0CAA0C;QAC1C,IAAIS,CAAAA,CAAAA,eAAAA,OAAOG,KAAKD,yBAAAA,0BAAAA,eAAgB,CAAC,gBAA7BF,0BAAAA,KAAAA,IAAAA,aAAiCI,MAAK,MAAM,GAAG;YACjD,OAAO,IAAI,CAACR,MAAM,CAACF,WAAW;QAChC;QACA,OAAOO;IACT;IAEQN,YAAYL,MAA0B,EAAU;QACtD,OAAOA,mBAAAA,oBAAAA,SAAU,IAAI,CAACe;IACxB;IAEQhB,qBAAqBC,MAA0B,EAAiC;YAC/E;QAAP,OAAO,CAAA,gCAAA,IAAI,CAACM,MAAM,CAAC,IAAI,CAACD,YAAYL,QAAQ,cAArC,2CAAA,gCAAyC,CAAC;IACnD;;QAlEA;;;GAGC,GACD,uBAACR,YAAa;QAEd,uBAAiBuB,6BAA4B;QAC7C,uBAAiBT,UAAwD,CAAC;;AA4D5E;AAMA,OAAO,MAAMU,0BAA0B3B,cAA+CmB,WAAW;AAEjG,SAASS;IACP,MAAMC,MAAM5B,WAAW0B;IACvB,IAAIE,QAAQV,WAAW;QACrB,MAAM,IAAIW,MAAM;IAClB;IACA,OAAOD;AACT;AAEA,OAAO,SAASE,0BAA0BC,KAAgB;IACxD,MAAM,EAAEC,MAAK,EAAE,GAAGL;IAElB,MAAMM,SAAShC,QAAQ;QACrB,MAAMgC,SAA2B,CAAC;QAClCF,kBAAAA,mBAAAA,KAAAA,IAAAA,MAAOG,QAAQ,CAACvB;YACd,MAAMwB,IAAIH,KAAK,CAACrB,KAAK;YACrB,IAAIwB,GAAG;gBACLF,MAAM,CAACtB,KAAK,GAAGwB;YACjB;QACF;QACA,OAAOF;IACT,GAAG;QAACD;QAAOD;KAAM;IAEjB,IAAIA,UAAUb,WAAW;QACvB,OAAOc;IACT;IAEA,OAAOC;AACT;AAEA,OAAO,SAASG,kBAAkBL,KAAgB;IAChD,MAAMM,yBAAyBP,0BAA0BC;IACzD,MAAMO,wBAAwBjC,yBAAyB0B;IAEvD,OAAOX,OAAOmB,OAAOF,wBAAwBC;AAC/C;AAEA,gEAAgE;AAChE,OAAO,SAASE,4BAA4BC,GAAuB;IACjE,MAAMC,oBAAoBD,MAAMtC,uBAAuBsC,OAAO,EAAE;IAChE,MAAME,iBAAiBP,kBAAkBM;IACzC,IAAI,CAACD,KAAK,OAAOvB;IACjB,OAAOd,yBAAyBqC,KAAKE;AACvC"}

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

@@ -1,4 +1,4 @@
-import { QueryCache } from '@tanstack/react-query';
+import { QueryCache, QueryObserverOptions } from '@tanstack/react-query';
 import { TimeSeriesQueryDefinition, TimeSeriesData } from '@perses-dev/core';
 import { TimeSeriesDataQuery } from '../model';
 export interface UseTimeSeriesQueryOptions {
@@ -8,11 +8,11 @@ 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<TimeSeriesData, unknown>;
+export declare const useTimeSeriesQuery: (definition: TimeSeriesQueryDefinition, options?: UseTimeSeriesQueryOptions, queryOptions?: QueryObserverOptions) => 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<TimeSeriesData, unknown>[];
+export declare function useTimeSeriesQueries(definitions: TimeSeriesQueryDefinition[], options?: UseTimeSeriesQueryOptions, queryOptions?: QueryObserverOptions): import("@tanstack/react-query").UseQueryResult<TimeSeriesData, unknown>[];
 /**
  * Get active time series queries for query results summary
  */

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,EAA+C,UAAU,EAAY,MAAM,uBAAuB,CAAC;AAC1G,OAAO,EAAE,yBAAyB,EAAe,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EAAE,mBAAmB,EAAiD,MAAM,UAAU,CAAC;AAM9F,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,4EAmB5G,CAAC;AAEF;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,yBAAyB,EAAE,EAAE,OAAO,CAAC,EAAE,yBAAyB,6EA2BjH;AAmBD;;GAEG;AACH,wBAAgB,0BAA0B,0BAIzC;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,UAAU,yBAW3D"}
+{"version":3,"file":"time-series-queries.d.ts","sourceRoot":"","sources":["../../src/runtime/time-series-queries.ts"],"names":[],"mappings":"AAaA,OAAO,EAKL,UAAU,EAEV,oBAAoB,EACrB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,yBAAyB,EAAe,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EAAE,mBAAmB,EAAiD,MAAM,UAAU,CAAC;AAM9F,MAAM,WAAW,yBAAyB;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,eAAO,MAAM,qBAAqB,oBAAoB,CAAC;AAmDvD;;GAEG;AACH,eAAO,MAAM,kBAAkB,eACjB,yBAAyB,YAC3B,yBAAyB,iBACpB,oBAAoB,4EAoBpC,CAAC;AAEF;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,yBAAyB,EAAE,EACxC,OAAO,CAAC,EAAE,yBAAyB,EACnC,YAAY,CAAC,EAAE,oBAAoB,6EA4BpC;AAmBD;;GAEG;AACH,wBAAgB,0BAA0B,0BAIzC;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,UAAU,yBAW3D"}

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

@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { useQuery, useQueries, useQueryClient } from '@tanstack/react-query';
-import { useTemplateVariableValues } from './template-variables';
+import { useVariableValues } from './template-variables';
 import { useTimeRange } from './TimeRangeProvider';
 import { useDatasourceStore } from './datasources';
 import { usePlugin, usePluginRegistry, usePlugins } from './plugin-registry';
@@ -46,8 +46,8 @@ function getQueryOptions({ plugin , definition , context  }) {
     let waitToLoad = false;
     if (variableDependencies) {
         waitToLoad = variableDependencies.some((v)=>{
-            var ref;
-            return (ref = variableState[v]) === null || ref === void 0 ? void 0 : ref.loading;
+            var _variableState_v;
+            return (_variableState_v = variableState[v]) === null || _variableState_v === void 0 ? void 0 : _variableState_v.loading;
         });
     }
     const queryEnabled = plugin !== undefined && !waitToLoad;
@@ -58,7 +58,7 @@ function getQueryOptions({ plugin , definition , context  }) {
 }
 /**
  * Runs a time series query using a plugin and returns the results.
- */ export const useTimeSeriesQuery = (definition, options)=>{
+ */ export const useTimeSeriesQuery = (definition, options, queryOptions)=>{
     const { data: plugin  } = usePlugin(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);
     const context = useTimeSeriesQueryContext();
     const { queryEnabled , queryKey  } = getQueryOptions({
@@ -66,8 +66,9 @@ function getQueryOptions({ plugin , definition , context  }) {
         definition,
         context
     });
+    var _queryOptions_enabled;
     return useQuery({
-        enabled: queryEnabled,
+        enabled: ((_queryOptions_enabled = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.enabled) !== null && _queryOptions_enabled !== void 0 ? _queryOptions_enabled : true) || queryEnabled,
         queryKey: queryKey,
         refetchInterval: context.refreshIntervalInMs > 0 ? context.refreshIntervalInMs : false,
         queryFn: ()=>{
@@ -86,7 +87,7 @@ function getQueryOptions({ plugin , definition , context  }) {
 };
 /**
  * Runs multiple time series queries using plugins and returns the results.
- */ export function useTimeSeriesQueries(definitions, options) {
+ */ export function useTimeSeriesQueries(definitions, options, queryOptions) {
     const { getPlugin  } = usePluginRegistry();
     const context = useTimeSeriesQueryContext();
     const pluginLoaderResponse = usePlugins(TIME_SERIES_QUERY_KEY, definitions.map((d)=>({
@@ -94,15 +95,16 @@ function getQueryOptions({ plugin , definition , context  }) {
         })));
     return useQueries({
         queries: definitions.map((definition, idx)=>{
-            var ref;
-            const plugin = (ref = pluginLoaderResponse[idx]) === null || ref === void 0 ? void 0 : ref.data;
+            var _pluginLoaderResponse_idx;
+            const plugin = (_pluginLoaderResponse_idx = pluginLoaderResponse[idx]) === null || _pluginLoaderResponse_idx === void 0 ? void 0 : _pluginLoaderResponse_idx.data;
             const { queryEnabled , queryKey  } = getQueryOptions({
                 plugin,
                 definition,
                 context
             });
+            var _queryOptions_enabled;
             return {
-                enabled: queryEnabled,
+                enabled: ((_queryOptions_enabled = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.enabled) !== null && _queryOptions_enabled !== void 0 ? _queryOptions_enabled : true) && queryEnabled,
                 queryKey: queryKey,
                 refetchInterval: context.refreshIntervalInMs > 0 ? context.refreshIntervalInMs : undefined,
                 queryFn: async ()=>{
@@ -123,7 +125,7 @@ function getQueryOptions({ plugin , definition , context  }) {
  * Build the time series query context object from data available at runtime
  */ function useTimeSeriesQueryContext() {
     const { absoluteTimeRange , refreshKey , refreshIntervalInMs  } = useTimeRange();
-    const variableState = useTemplateVariableValues();
+    const variableState = useVariableValues();
     const datasourceStore = useDatasourceStore();
     return {
         timeRange: absoluteTimeRange,
@@ -147,8 +149,8 @@ function getQueryOptions({ plugin , definition , context  }) {
     for (const query of cache.findAll({
         type: 'active'
     })){
-        var ref;
-        const firstPart = (ref = query.queryKey) === null || ref === void 0 ? void 0 : ref[0];
+        var _query_queryKey;
+        const firstPart = (_query_queryKey = query.queryKey) === null || _query_queryKey === void 0 ? void 0 : _query_queryKey[0];
         if ((firstPart === null || firstPart === void 0 ? void 0 : firstPart.kind) && firstPart.kind.startsWith(TIME_SERIES_QUERY_KEY)) {
             queries.push(query);
         }

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 { useQuery, useQueries, useQueryClient, Query, QueryCache, QueryKey } from '@tanstack/react-query';\nimport { TimeSeriesQueryDefinition, UnknownSpec, TimeSeriesData } from '@perses-dev/core';\nimport { TimeSeriesDataQuery, TimeSeriesQueryContext, TimeSeriesQueryPlugin } from '../model';\nimport { VariableStateMap, 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    refetchInterval: context.refreshIntervalInMs > 0 ? context.refreshIntervalInMs : false,\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        refetchInterval: context.refreshIntervalInMs > 0 ? context.refreshIntervalInMs : undefined,\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, refreshIntervalInMs } = useTimeRange();\n  const variableState = useTemplateVariableValues();\n  const datasourceStore = useDatasourceStore();\n\n  return {\n    timeRange: absoluteTimeRange,\n    variableState,\n    datasourceStore,\n    refreshKey,\n    refreshIntervalInMs: refreshIntervalInMs,\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","refetchInterval","refreshIntervalInMs","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;AAG1G,SAA2BC,yBAAyB,QAAQ,sBAAsB,CAAC;AACnF,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,eAAe,EAAEzB,OAAO,CAAC0B,mBAAmB,GAAG,CAAC,GAAG1B,OAAO,CAAC0B,mBAAmB,GAAG,KAAK;QACtFC,OAAO,EAAE,IAAM;YACb,iGAAiG;YACjG,IAAI7B,MAAM,KAAKoB,SAAS,EAAE;gBACxB,MAAM,IAAIU,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YACD,0FAA0F;YAC1F,MAAMC,GAAG,GAA2B;gBAAE,GAAG7B,OAAO;gBAAEG,eAAe,EAAEiB,OAAO,aAAPA,OAAO,WAAiB,GAAxBA,KAAAA,CAAwB,GAAxBA,OAAO,CAAEjB,eAAe;aAAE,AAAC;YAC9F,OAAOL,MAAM,CAACgC,iBAAiB,CAAC/B,UAAU,CAACS,IAAI,CAACV,MAAM,CAACU,IAAI,EAAEqB,GAAG,CAAC,CAAC;QACpE,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;CAEC,GACD,OAAO,SAASE,oBAAoB,CAACC,WAAwC,EAAEZ,OAAmC,EAAE;IAClH,MAAM,EAAEa,SAAS,CAAA,EAAE,GAAGvD,iBAAiB,EAAE,AAAC;IAC1C,MAAMsB,OAAO,GAAGuB,yBAAyB,EAAE,AAAC;IAE5C,MAAMW,oBAAoB,GAAGvD,UAAU,CACrCC,qBAAqB,EACrBoD,WAAW,CAAC/C,GAAG,CAAC,CAACkD,CAAC,GAAM,CAAA;YAAEb,IAAI,EAAEa,CAAC,CAAC3B,IAAI,CAACV,MAAM,CAACwB,IAAI;SAAE,CAAA,AAAC,CAAC,CACvD,AAAC;IAEF,OAAOlD,UAAU,CAAC;QAChBgE,OAAO,EAAEJ,WAAW,CAAC/C,GAAG,CAAC,CAACc,UAAU,EAAEsC,GAAG,GAAK;gBAC7BH,GAAyB;YAAxC,MAAMpC,MAAM,GAAGoC,CAAAA,GAAyB,GAAzBA,oBAAoB,CAACG,GAAG,CAAC,cAAzBH,GAAyB,WAAM,GAA/BA,KAAAA,CAA+B,GAA/BA,GAAyB,CAAEb,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,eAAe,EAAEzB,OAAO,CAAC0B,mBAAmB,GAAG,CAAC,GAAG1B,OAAO,CAAC0B,mBAAmB,GAAGR,SAAS;gBAC1FS,OAAO,EAAE,UAAY;oBACnB,0FAA0F;oBAC1F,MAAME,GAAG,GAA2B;wBAAE,GAAG7B,OAAO;wBAAEG,eAAe,EAAEiB,OAAO,aAAPA,OAAO,WAAiB,GAAxBA,KAAAA,CAAwB,GAAxBA,OAAO,CAAEjB,eAAe;qBAAE,AAAC;oBAC9F,MAAML,MAAM,GAAG,MAAMmC,SAAS,CAACrD,qBAAqB,EAAEmB,UAAU,CAACS,IAAI,CAACV,MAAM,CAACwB,IAAI,CAAC,AAAC;oBACnF,MAAMD,IAAI,GAAG,MAAMvB,MAAM,CAACgC,iBAAiB,CAAC/B,UAAU,CAACS,IAAI,CAACV,MAAM,CAACU,IAAI,EAAEqB,GAAG,CAAC,AAAC;oBAC9E,OAAOR,IAAI,CAAC;gBACd,CAAC;aACF,CAAC;QACJ,CAAC,CAAC;KACH,CAAC,CAAC;AACL,CAAC;AAED;;CAEC,GACD,SAASE,yBAAyB,GAA2B;IAC3D,MAAM,EAAEe,iBAAiB,CAAA,EAAEjC,UAAU,CAAA,EAAEqB,mBAAmB,CAAA,EAAE,GAAGnD,YAAY,EAAE,AAAC;IAC9E,MAAM6B,aAAa,GAAG9B,yBAAyB,EAAE,AAAC;IAClD,MAAM4B,eAAe,GAAG1B,kBAAkB,EAAE,AAAC;IAE7C,OAAO;QACLyB,SAAS,EAAEqC,iBAAiB;QAC5BlC,aAAa;QACbF,eAAe;QACfG,UAAU;QACVqB,mBAAmB,EAAEA,mBAAmB;KACzC,CAAC;AACJ,CAAC;AAED;;CAEC,GACD,OAAO,SAASa,0BAA0B,GAAG;IAC3C,MAAMC,WAAW,GAAGnE,cAAc,EAAE,AAAC;IACrC,MAAMoE,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,CAAChC,QAAQ,cAAdgC,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,CAAE1B,IAAI,CAAA,IAAI,AAAC0B,SAAS,CAAC1B,IAAI,CAAY2B,UAAU,CAACrE,qBAAqB,CAAC,EAAE;YACnFwD,OAAO,CAACc,IAAI,CAACL,KAAK,CAA6D,CAAC;QAClF,CAAC;IACH,CAAC;IAED,OAAOT,OAAO,CAAC;AACjB,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 {\n  useQuery,\n  useQueries,\n  useQueryClient,\n  Query,\n  QueryCache,\n  QueryKey,\n  QueryObserverOptions,\n} from '@tanstack/react-query';\nimport { TimeSeriesQueryDefinition, UnknownSpec, TimeSeriesData } from '@perses-dev/core';\nimport { TimeSeriesDataQuery, TimeSeriesQueryContext, TimeSeriesQueryPlugin } from '../model';\nimport { VariableStateMap, useVariableValues } 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 = (\n  definition: TimeSeriesQueryDefinition,\n  options?: UseTimeSeriesQueryOptions,\n  queryOptions?: QueryObserverOptions\n) => {\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: (queryOptions?.enabled ?? true) || queryEnabled,\n    queryKey: queryKey,\n    refetchInterval: context.refreshIntervalInMs > 0 ? context.refreshIntervalInMs : false,\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(\n  definitions: TimeSeriesQueryDefinition[],\n  options?: UseTimeSeriesQueryOptions,\n  queryOptions?: QueryObserverOptions\n) {\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: (queryOptions?.enabled ?? true) && queryEnabled,\n        queryKey: queryKey,\n        refetchInterval: context.refreshIntervalInMs > 0 ? context.refreshIntervalInMs : undefined,\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, refreshIntervalInMs } = useTimeRange();\n  const variableState = useVariableValues();\n  const datasourceStore = useDatasourceStore();\n\n  return {\n    timeRange: absoluteTimeRange,\n    variableState,\n    datasourceStore,\n    refreshKey,\n    refreshIntervalInMs: refreshIntervalInMs,\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","useVariableValues","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","queryOptions","data","kind","useTimeSeriesQueryContext","enabled","refetchInterval","refreshIntervalInMs","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,SACEA,QAAQ,EACRC,UAAU,EACVC,cAAc,QAKT,wBAAwB;AAG/B,SAA2BC,iBAAiB,QAAQ,uBAAuB;AAC3E,SAASC,YAAY,QAAQ,sBAAsB;AACnD,SAASC,kBAAkB,QAAQ,gBAAgB;AACnD,SAASC,SAAS,EAAEC,iBAAiB,EAAEC,UAAU,QAAQ,oBAAoB;AAM7E,OAAO,MAAMC,wBAAwB,kBAAkB;AAEvD;;CAEC,GACD,SAASC,qBAAqBC,CAAmB;IAC/C,OAAOC,OAAOC,OAAOF,GAClBG,IAAI,CAACH,IAAMI,KAAKC,UAAUL,EAAEM,QAC5BC,KAAK;AACV;AAEA,SAASC,uBAAuBR,CAAmB,EAAES,KAAgB;IACnE,IAAI,CAACA,OAAO;QACV,OAAOT;IACT;IACA,OAAOC,OAAOS,YAAYT,OAAOU,QAAQX,GAAGY,OAAO,CAAC,CAACC,KAAK,GAAKJ,MAAMK,SAASD;AAChF;AAEA,SAASE,gBAAgB,EACvBC,OAAM,EACNC,WAAU,EACVC,QAAO,EAKR;IACC,MAAM,EAAEC,UAAS,EAAEC,gBAAe,EAAEC,gBAAe,EAAEC,cAAa,EAAEC,WAAU,EAAE,GAAGL;IAEnF,MAAMM,eAAeR,CAAAA,mBAAAA,oBAAAA,KAAAA,IAAAA,OAAQS,SAAQ,IAAIT,OAAOS,UAAUR,WAAWS,KAAKV,OAAOU,MAAMR,WAAW,CAAC;IACnG,MAAMS,uBAAuBH,yBAAAA,0BAAAA,KAAAA,IAAAA,aAAcI;IAE3C,qBAAqB;IACrB,MAAMC,yBAAyBrB,uBAAuBc,eAAeK;IACrE,MAAMG,oBAAoB/B,qBAAqB8B;IAC/C,MAAME,WAAW;QAACd;QAAYE;QAAWC;QAAiBC;QAAiBS;QAAmBP;KAAW;IAEzG,yBAAyB;IACzB,IAAIS,aAAa;IACjB,IAAIL,sBAAsB;QACxBK,aAAaL,qBAAqBM,KAAK,CAACjC;gBAAMsB;YAAAA,OAAAA,CAAAA,mBAAAA,aAAa,CAACtB,EAAE,cAAhBsB,8BAAAA,KAAAA,IAAAA,iBAAkBY;;IAClE;IAEA,MAAMC,eAAenB,WAAWoB,aAAa,CAACJ;IAE9C,OAAO;QACLD;QACAI;IACF;AACF;AAEA;;CAEC,GACD,OAAO,MAAME,qBAAqB,CAChCpB,YACAqB,SACAC;IAEA,MAAM,EAAEC,MAAMxB,OAAM,EAAE,GAAGrB,UAAUG,uBAAuBmB,WAAWS,KAAKV,OAAOyB;IACjF,MAAMvB,UAAUwB;IAEhB,MAAM,EAAEP,aAAY,EAAEJ,SAAQ,EAAE,GAAGhB,gBAAgB;QAAEC;QAAQC;QAAYC;IAAQ;QAErEqB;IADZ,OAAOlD,SAAS;QACdsD,SAAS,AAACJ,CAAAA,CAAAA,wBAAAA,yBAAAA,0BAAAA,KAAAA,IAAAA,aAAcI,qBAAdJ,mCAAAA,wBAAyB,IAAG,KAAMJ;QAC5CJ,UAAUA;QACVa,iBAAiB1B,QAAQ2B,sBAAsB,IAAI3B,QAAQ2B,sBAAsB;QACjFC,SAAS;YACP,iGAAiG;YACjG,IAAI9B,WAAWoB,WAAW;gBACxB,MAAM,IAAIW,MAAM;YAClB;YACA,0FAA0F;YAC1F,MAAMC,MAA8B;gBAAE,GAAG9B,OAAO;gBAAEG,iBAAiBiB,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASjB;YAAgB;YAC5F,OAAOL,OAAOiC,kBAAkBhC,WAAWS,KAAKV,OAAOU,MAAMsB;QAC/D;IACF;AACF,EAAE;AAEF;;CAEC,GACD,OAAO,SAASE,qBACdC,WAAwC,EACxCb,OAAmC,EACnCC,YAAmC;IAEnC,MAAM,EAAEa,UAAS,EAAE,GAAGxD;IACtB,MAAMsB,UAAUwB;IAEhB,MAAMW,uBAAuBxD,WAC3BC,uBACAqD,YAAYhD,IAAI,CAACmD,IAAO,CAAA;YAAEb,MAAMa,EAAE5B,KAAKV,OAAOyB;QAAK,CAAA;IAGrD,OAAOnD,WAAW;QAChBiE,SAASJ,YAAYhD,IAAI,CAACc,YAAYuC;gBACrBH;YAAf,MAAMrC,SAASqC,CAAAA,4BAAAA,oBAAoB,CAACG,IAAI,cAAzBH,uCAAAA,KAAAA,IAAAA,0BAA2Bb;YAC1C,MAAM,EAAEL,aAAY,EAAEJ,SAAQ,EAAE,GAAGhB,gBAAgB;gBAAEC;gBAAQC;gBAAYC;YAAQ;gBAErEqB;YADZ,OAAO;gBACLI,SAAS,AAACJ,CAAAA,CAAAA,wBAAAA,yBAAAA,0BAAAA,KAAAA,IAAAA,aAAcI,qBAAdJ,mCAAAA,wBAAyB,IAAG,KAAMJ;gBAC5CJ,UAAUA;gBACVa,iBAAiB1B,QAAQ2B,sBAAsB,IAAI3B,QAAQ2B,sBAAsBT;gBACjFU,SAAS;oBACP,0FAA0F;oBAC1F,MAAME,MAA8B;wBAAE,GAAG9B,OAAO;wBAAEG,iBAAiBiB,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASjB;oBAAgB;oBAC5F,MAAML,SAAS,MAAMoC,UAAUtD,uBAAuBmB,WAAWS,KAAKV,OAAOyB;oBAC7E,MAAMD,OAAO,MAAMxB,OAAOiC,kBAAkBhC,WAAWS,KAAKV,OAAOU,MAAMsB;oBACzE,OAAOR;gBACT;YACF;QACF;IACF;AACF;AAEA;;CAEC,GACD,SAASE;IACP,MAAM,EAAEe,kBAAiB,EAAElC,WAAU,EAAEsB,oBAAmB,EAAE,GAAGpD;IAC/D,MAAM6B,gBAAgB9B;IACtB,MAAM4B,kBAAkB1B;IAExB,OAAO;QACLyB,WAAWsC;QACXnC;QACAF;QACAG;QACAsB,qBAAqBA;IACvB;AACF;AAEA;;CAEC,GACD,OAAO,SAASa;IACd,MAAMC,cAAcpE;IACpB,MAAMqE,aAAaD,YAAYE;IAC/B,OAAOC,2BAA2BF;AACpC;AAEA;;CAEC,GACD,OAAO,SAASE,2BAA2BC,KAAiB;IAC1D,MAAMR,UAAiC,EAAE;IAEzC,KAAK,MAAMS,SAASD,MAAME,QAAQ;QAAEC,MAAM;IAAS,GAAI;YACnCF;QAAlB,MAAMG,YAAYH,CAAAA,kBAAAA,MAAMjC,sBAANiC,6BAAAA,KAAAA,IAAAA,eAAgB,CAAC,EAAE;QACrC,IAAIG,CAAAA,sBAAAA,uBAAAA,KAAAA,IAAAA,UAAW1B,IAAG,KAAK,AAAC0B,UAAU1B,KAAgB2B,WAAWtE,wBAAwB;YACnFyD,QAAQc,KAAKL;QACf;IACF;IAEA,OAAOT;AACT"}