@perses-dev/plugin-system 0.0.0-snapshot-panel-extra-content-3-17f9c42 → 0.0.0-snapshot-scatterplot-fix-imports-95e1b59

package/dist/runtime/datasources.d.ts

@@ -7,23 +7,58 @@ export interface DatasourceStore {
      */
     getDatasourceClient<Client>(selector: DatasourceSelector): Promise<Client>;
     /**
-     * Gets a list of datasource metadata for a plugin kind.
+     * Gets a list of datasource selection items for a plugin kind.
      */
-    listDatasourceMetadata(datasourcePluginKind: string): Promise<DatasourceMetadata[]>;
+    listDatasourceSelectItems(datasourcePluginKind: string): Promise<DatasourceSelectItemGroup[]>;
+    /**
+     * Gets the list of datasources defined in the dashboard
+     */
+    getLocalDatasources(): Record<string, DatasourceSpec>;
+    /**
+     * Sets the list of datasources defined in the dashboard
+     */
+    setLocalDatasources(datasources: Record<string, DatasourceSpec>): void;
+    /**
+     * Gets the list of datasources that are available in the dashboard (i.e. dashboards that have been created on the server side that we can use).
+     */
+    getSavedDatasources(): Record<string, DatasourceSpec>;
+    /**
+     * Sets the list of datasources that are saved in the dashboard
+     */
+    setSavedDatasources(datasources: Record<string, DatasourceSpec>): void;
+}
+export interface DatasourceSelectItemGroup {
+    group?: string;
+    editLink?: string;
+    items: DatasourceSelectItem[];
 }
-export interface DatasourceMetadata {
+export interface DatasourceSelectItem {
     name: string;
-    selector: DatasourceSelector;
+    overridden?: boolean;
+    overriding?: boolean;
+    saved?: boolean;
+    selector: DatasourceSelectItemSelector;
+}
+/**
+ * Datasource Selector used by the frontend only to differentiate datasources coming from different group.
+ */
+export interface DatasourceSelectItemSelector extends DatasourceSelector {
+    /**
+     * Group of the datasource.
+     * Omit it if you don't store datasource by group.
+     */
+    group?: string;
 }
 export declare const DatasourceStoreContext: import("react").Context<DatasourceStore | undefined>;
 export declare function useDatasourceStore(): DatasourceStore;
 /**
- * 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.
+ * 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 declare function useListDatasources(datasourcePluginKind: string): import("@tanstack/react-query").UseQueryResult<DatasourceMetadata[], unknown>;
+export declare function useListDatasourceSelectItems(datasourcePluginKind: string, project?: string): import("@tanstack/react-query").UseQueryResult<DatasourceSelectItemGroup[], unknown>;
 /**
  * Provides a convenience hook for getting a DatasourceClient for a given DatasourceSelector.
  */
 export declare function useDatasourceClient<Client>(selector: DatasourceSelector): import("@tanstack/react-query").UseQueryResult<Client, unknown>;
+export declare function useDatasource(selector: DatasourceSelector): import("@tanstack/react-query").UseQueryResult<DatasourceSpec<import("@perses-dev/core").UnknownSpec>, unknown>;
 //# sourceMappingURL=datasources.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"datasources.d.ts","sourceRoot":"","sources":["../../src/runtime/datasources.ts"],"names":[],"mappings":";AAaA,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAItE,MAAM,WAAW,eAAe;IAE9B,aAAa,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAErE;;OAEG;IACH,mBAAmB,CAAC,MAAM,EAAE,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3E;;OAEG;IACH,sBAAsB,CAAC,oBAAoB,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;CACrF;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,eAAO,MAAM,sBAAsB,sDAAwD,CAAC;AAE5F,wBAAgB,kBAAkB,oBAMjC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,oBAAoB,EAAE,MAAM,iFAG9D;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,QAAQ,EAAE,kBAAkB,mEAGvE"}
+{"version":3,"file":"datasources.d.ts","sourceRoot":"","sources":["../../src/runtime/datasources.ts"],"names":[],"mappings":";AAaA,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAItE,MAAM,WAAW,eAAe;IAE9B,aAAa,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAErE;;OAEG;IACH,mBAAmB,CAAC,MAAM,EAAE,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3E;;OAEG;IACH,yBAAyB,CAAC,oBAAoB,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;IAE9F;;OAEG;IACH,mBAAmB,IAAI,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAEtD;;OAEG;IACH,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,IAAI,CAAC;IAEvE;;OAEG;IACH,mBAAmB,IAAI,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAEtD;;OAEG;IACH,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,IAAI,CAAC;CACxE;AAED,MAAM,WAAW,yBAAyB;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,oBAAoB,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,4BAA4B,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,kBAAkB;IACtE;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,eAAO,MAAM,sBAAsB,sDAAwD,CAAC;AAE5F,wBAAgB,kBAAkB,oBAMjC;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,oBAAoB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,wFAK1F;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,QAAQ,EAAE,kBAAkB,mEAGvE;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,kBAAkB,mHAGzD"}

package/dist/runtime/datasources.js

@@ -21,14 +21,15 @@ 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, project) {
+    const { listDatasourceSelectItems } = useDatasourceStore();
     return useQuery([
-        'listDatasourceMetadata',
-        datasourcePluginKind
-    ], ()=>listDatasourceMetadata(datasourcePluginKind));
+        'listDatasourceSelectItems',
+        datasourcePluginKind,
+        project
+    ], ()=>listDatasourceSelectItems(datasourcePluginKind));
 }
 /**
  * Provides a convenience hook for getting a DatasourceClient for a given DatasourceSelector.
@@ -39,5 +40,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  /**\n   * Gets the list of datasources defined in the dashboard\n   */\n  getLocalDatasources(): Record<string, DatasourceSpec>;\n\n  /**\n   * Sets the list of datasources defined in the dashboard\n   */\n  setLocalDatasources(datasources: Record<string, DatasourceSpec>): void;\n\n  /**\n   * Gets the list of datasources that are available in the dashboard (i.e. dashboards that have been created on the server side that we can use).\n   */\n  getSavedDatasources(): Record<string, DatasourceSpec>;\n\n  /**\n   * Sets the list of datasources that are saved in the dashboard\n   */\n  setSavedDatasources(datasources: Record<string, DatasourceSpec>): void;\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  saved?: boolean;\n  selector: DatasourceSelectItemSelector;\n}\n\n/**\n * Datasource Selector used by the frontend only to differentiate datasources coming from different group.\n */\nexport interface DatasourceSelectItemSelector extends DatasourceSelector {\n  /**\n   * Group of the datasource.\n   * Omit it if you don't store datasource by group.\n   */\n  group?: string;\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, project?: string) {\n  const { listDatasourceSelectItems } = useDatasourceStore();\n  return useQuery(['listDatasourceSelectItems', datasourcePluginKind, project], () =>\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","project","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;AA8DlD,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,EAAEC,OAAgB;IACzF,MAAM,EAAEC,yBAAyB,EAAE,GAAGN;IACtC,OAAOL,SAAS;QAAC;QAA6BS;QAAsBC;KAAQ,EAAE,IAC5EC,0BAA0BF;AAE9B;AAEA;;CAEC,GACD,OAAO,SAASG,oBAA4BC,QAA4B;IACtE,MAAMC,QAAQT;IACd,OAAOL,SAAiB;QAAC;QAAuBa;KAAS,EAAE,IAAMC,MAAMC,mBAAmB,CAASF;AACrG;AAEA,OAAO,SAASG,cAAcH,QAA4B;IACxD,MAAMC,QAAQT;IACd,OAAOL,SAAS;QAAC;QAAiBa;KAAS,EAAE,IAAMC,MAAMG,aAAa,CAACJ;AACzE"}

package/dist/runtime/index.d.ts

@@ -1,7 +1,9 @@
+export * from './builtin-variables';
 export * from './datasources';
 export * from './plugin-registry';
 export * from './template-variables';
 export * from './TimeRangeProvider';
 export * from './time-series-queries';
+export * from './trace-queries';
 export * from './DataQueriesProvider';
 //# sourceMappingURL=index.d.ts.map

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,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC"}

package/dist/runtime/index.js

@@ -10,11 +10,13 @@
 // 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';
 export * from './TimeRangeProvider';
 export * from './time-series-queries';
+export * from './trace-queries';
 export * from './DataQueriesProvider';
 
 //# sourceMappingURL=index.js.map

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 './trace-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,kBAAkB;AAChC,cAAc,wBAAwB"}

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

@@ -1,10 +1,11 @@
 /// <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>>;
     listPluginMetadata(pluginType: PluginType): Promise<PluginMetadata[]>;
-    defaultPluginKinds: DefaultPluginKinds;
+    defaultPluginKinds?: DefaultPluginKinds;
 }
 export declare const PluginRegistryContext: import("react").Context<PluginRegistryContextType | undefined>;
 /**
@@ -12,7 +13,7 @@ export declare const PluginRegistryContext: import("react").Context<PluginRegist
  * be using `usePlugin` or `useListPluginMetadata` instead.
  */
 export declare function usePluginRegistry(): PluginRegistryContextType;
-declare type UsePluginOptions<T extends PluginType> = Omit<UseQueryOptions<PluginImplementation<T>, Error, PluginImplementation<T>, [string, PluginType, string]>, 'queryKey' | 'queryFn'>;
+type UsePluginOptions<T extends PluginType> = Omit<UseQueryOptions<PluginImplementation<T>, Error, PluginImplementation<T>, [string, PluginType, string]>, 'queryKey' | 'queryFn'>;
 /**
  * Loads a plugin and returns the plugin implementation, along with loading/error state.
  */
@@ -23,10 +24,11 @@ export declare function usePlugin<T extends PluginType>(pluginType: T, kind: str
 export declare function usePlugins<T extends PluginType>(pluginType: T, plugins: Array<{
     kind: string;
 }>): import("@tanstack/react-query").UseQueryResult<PluginImplementation<T>, unknown>[];
-declare type UseListPluginMetadataOptions = Omit<UseQueryOptions<PluginMetadata[], Error, PluginMetadata[], [string, PluginType]>, 'queryKey' | 'queryFn'>;
+type UseListPluginMetadataOptions = Omit<UseQueryOptions<PluginMetadata[], Error, PluginMetadata[], [string, PluginType]>, 'queryKey' | 'queryFn'>;
 /**
  * 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,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED,eAAO,MAAM,qBAAqB,gEAAkE,CAAC;AAErG;;;GAGG;AACH,wBAAgB,iBAAiB,8BAMhC;AAGD,KAAK,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,KAAK,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,13 +26,13 @@ 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();
+    const { getPlugin } = usePluginRegistry();
     return useQuery([
         'getPlugin',
         pluginType,
@@ -42,7 +42,7 @@ export const PluginRegistryContext = createContext(undefined);
 /**
  * Loads a list of plugins and returns the plugin implementation, along with loading/error state.
  */ export function usePlugins(pluginType, plugins) {
-    const { getPlugin  } = usePluginRegistry();
+    const { getPlugin } = usePluginRegistry();
     return useQueries({
         queries: plugins.map((p)=>{
             return {
@@ -59,11 +59,28 @@ export const PluginRegistryContext = createContext(undefined);
 /**
  * Gets a list of plugin metadata for the specified plugin type and returns it, along with loading/error state.
  */ export function useListPluginMetadata(pluginType, options) {
-    const { listPluginMetadata  } = usePluginRegistry();
+    const { listPluginMetadata } = usePluginRegistry();
     return useQuery([
         'listPluginMetadata',
         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,8BAAAA,QAASC,OAAO,cAAhBD,8BAAAA,mBAAoB,IAAG,KAAMD,SAAS;IAClD;IACA,MAAM,EAAEG,SAAS,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,SAAS,EAAE,GAAGR;IACtB,OAAOH,WAAW;QAChBc,SAASD,QAAQE,GAAG,CAAC,CAACC;YACpB,OAAO;gBACLC,UAAU;oBAAC;oBAAaV;oBAAYS,EAAER,IAAI;iBAAC;gBAC3CU,SAAS,IAAMP,UAAUJ,YAAYS,EAAER,IAAI;YAC7C;QACF;IACF;AACF;AAQA;;CAEC,GACD,OAAO,SAASW,sBAAsBZ,UAAsB,EAAEE,OAAsC;IAClG,MAAM,EAAEW,kBAAkB,EAAE,GAAGjB;IAC/B,OAAOJ,SAAS;QAAC;QAAsBQ;KAAW,EAAE,IAAMa,mBAAmBb,aAAaE;AAC5F;AAEA,OAAO,SAASY;IACd,MAAM,EAAEV,SAAS,EAAES,kBAAkB,EAAE,GAAGjB;IAE1C,OAAOJ,SAAS;QAAC;KAAsC,EAAE;QACvD,MAAMuB,cAAc,MAAMF,mBAAmB;QAC7C,MAAMG,kBAAkB,IAAIC,IAAIF,YAAYP,GAAG,CAAC,CAACU,aAAeA,WAAWjB,IAAI;QAC/E,MAAMkB,SAAsC,EAAE;QAC9C,KAAK,MAAMlB,QAAQe,gBAAiB;YAClC,MAAMI,SAAS,MAAMhB,UAAU,cAAcH;YAC7C,IAAImB,OAAOC,6BAA6B,EAAE;gBACxCD,OAAOC,6BAA6B,GAAGC,OAAO,CAAC,CAACC,aAAeJ,OAAOK,IAAI,CAACD;YAC7E;QACF;QACA,OAAOJ;IACT;AACF"}

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

@@ -2,7 +2,7 @@
 import { VariableValue } from '@perses-dev/core';
 import { immerable } from 'immer';
 import { VariableOption } from '../model';
-export declare type VariableState = {
+export type VariableState = {
     value: VariableValue;
     options?: VariableOption[];
     loading: boolean;
@@ -15,13 +15,13 @@ export declare type VariableState = {
      * If a local variable is overriding an external variable, external var will have the flag ``overridden=true``.
      */
     overridden?: boolean;
-    default_value?: VariableValue;
+    defaultValue?: VariableValue;
 };
-export declare type VariableStateMap = Record<string, VariableState>;
+export type VariableStateMap = Record<string, VariableState>;
 /**
  * Structure used as key in the {@link VariableStoreStateMap}.
  */
-export declare type VariableStateKey = {
+export type VariableStateKey = {
     /**
      * name of the variable we want to access in the state.
      */
@@ -67,10 +67,11 @@ export declare class VariableStoreStateMap {
     private _sourceName;
     private _sourceStatesOrEmpty;
 }
-export declare type TemplateVariableSrv = {
+export 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,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,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;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,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,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,MAAM,MAAM,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,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,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,MAAM,MAAM,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,CAOpE;AAGD,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAKvF"}

package/dist/runtime/template-variables.js

@@ -10,9 +10,23 @@
 // 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.
@@ -45,7 +59,7 @@ let _immerable = immerable;
    * Delete variable state by key.
    * @param key
    */ delete(key) {
-        var ref;
+        var _Object_keys;
         const result = this.has(key);
         const sourceName = this._sourceName(key.source);
         const sourceStates = this._state[sourceName];
@@ -54,7 +68,7 @@ let _immerable = immerable;
             delete sourceStates[key.name];
         }
         // Delete source state from state if empty
-        if (((ref = Object.keys(sourceStates !== null && sourceStates !== void 0 ? sourceStates : {})) === null || ref === void 0 ? void 0 : ref.length) === 0) {
+        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;
@@ -63,16 +77,16 @@ let _immerable = immerable;
         return source !== null && source !== void 0 ? source : this.DEFAULT_LOCAL_SOURCE_NAME;
     }
     _sourceStatesOrEmpty(source) {
-        var ref;
-        return (ref = this._state[this._sourceName(source)]) !== null && ref !== void 0 ? ref : {};
+        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
-   */ this[_immerable] = true;
-        this.DEFAULT_LOCAL_SOURCE_NAME = '';
-        this._state = {};
+   */ _define_property(this, _immerable, true);
+        _define_property(this, "DEFAULT_LOCAL_SOURCE_NAME", '');
+        _define_property(this, "_state", {});
     }
 }
 export const TemplateVariableContext = createContext(undefined);
@@ -84,7 +98,7 @@ function useTemplateVariableContext() {
     return ctx;
 }
 export function useTemplateVariableValues(names) {
-    const { state  } = useTemplateVariableContext();
+    const { state } = useTemplateVariableContext();
     const values = useMemo(()=>{
         const values = {};
         names === null || names === void 0 ? void 0 : names.forEach((name)=>{
@@ -103,10 +117,23 @@ export function useTemplateVariableValues(names) {
     }
     return values;
 }
+export function useVariableValues(names) {
+    const templateVariableValues = useTemplateVariableValues(names);
+    const builtinVariableValues = useBuiltinVariableValues(names);
+    return useMemo(()=>{
+        return {
+            ...templateVariableValues,
+            ...builtinVariableValues
+        };
+    }, [
+        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 { VariableValue } from '@perses-dev/core';\nimport { immerable } from 'immer';\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   * 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  default_value?: 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[]) {\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","immerable","parseTemplateVariables","replaceTemplateVariables","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","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;AAE3D,SAASC,SAAS,QAAQ,OAAO,CAAC;AAElC,SAASC,sBAAsB,EAAEC,wBAAwB,QAAQ,UAAU,CAAC;IA2CzEF,UAAS,GAATA,SAAS;AARZ;;CAEC,GACD,OAAO,MAAMG,qBAAqB;IAUhC;;;GAGC,GACDC,GAAG,CAACC,GAAqB,EAA6B;QACpD,OAAO,IAAI,CAACC,oBAAoB,CAACD,GAAG,CAACE,MAAM,CAAC,CAACF,GAAG,CAACG,IAAI,CAAC,CAAC;IACzD;IAEA;;;;GAIC,GACDC,GAAG,CAACJ,GAAqB,EAAEK,KAAoB,EAA6B;QAC1E,MAAMC,UAAU,GAAG,IAAI,CAACC,WAAW,CAACP,GAAG,CAACE,MAAM,CAAC,AAAC;QAChD,IAAI,CAAC,IAAI,CAACM,MAAM,CAACF,UAAU,CAAC,EAAE;YAC5B,IAAI,CAACE,MAAM,CAACF,UAAU,CAAC,GAAG,EAAE,CAAC;QAC/B,CAAC;QACD,IAAI,CAACL,oBAAoB,CAACD,GAAG,CAACE,MAAM,CAAC,CAACF,GAAG,CAACG,IAAI,CAAC,GAAGE,KAAK,CAAC;QACxD,OAAOA,KAAK,CAAC;IACf;IAEA;;;GAGC,GACDI,GAAG,CAACT,GAAqB,EAAW;QAClC,OAAO,IAAI,CAACC,oBAAoB,CAACD,GAAG,CAACE,MAAM,CAAC,CAACF,GAAG,CAACG,IAAI,CAAC,KAAKO,SAAS,CAAC;IACvE;IAEA;;;GAGC,GACDC,MAAM,CAACX,GAAqB,EAAW;YAWjCY,GAA+B;QAVnC,MAAMC,MAAM,GAAG,IAAI,CAACJ,GAAG,CAACT,GAAG,CAAC,AAAC;QAC7B,MAAMM,UAAU,GAAG,IAAI,CAACC,WAAW,CAACP,GAAG,CAACE,MAAM,CAAC,AAAC;QAChD,MAAMY,YAAY,GAAG,IAAI,CAACN,MAAM,CAACF,UAAU,CAAC,AAAC;QAE7C,+BAA+B;QAC/B,IAAIQ,YAAY,EAAE;YAChB,OAAOA,YAAY,CAACd,GAAG,CAACG,IAAI,CAAC,CAAC;QAChC,CAAC;QAED,0CAA0C;QAC1C,IAAIS,CAAAA,CAAAA,GAA+B,GAA/BA,MAAM,CAACG,IAAI,CAACD,YAAY,aAAZA,YAAY,cAAZA,YAAY,GAAI,EAAE,CAAC,cAA/BF,GAA+B,WAAQ,GAAvCA,KAAAA,CAAuC,GAAvCA,GAA+B,CAAEI,MAAM,CAAA,KAAK,CAAC,EAAE;YACjD,OAAO,IAAI,CAACR,MAAM,CAACF,UAAU,CAAC,CAAC;QACjC,CAAC;QACD,OAAOO,MAAM,CAAC;IAChB;IAEQN,WAAW,CAACL,MAA0B,EAAU;QACtD,OAAOA,MAAM,aAANA,MAAM,cAANA,MAAM,GAAI,IAAI,CAACe,yBAAyB,CAAC;IAClD;IAEQhB,oBAAoB,CAACC,MAA0B,EAAiC;YAC/E,GAAqC;QAA5C,OAAO,CAAA,GAAqC,GAArC,IAAI,CAACM,MAAM,CAAC,IAAI,CAACD,WAAW,CAACL,MAAM,CAAC,CAAC,cAArC,GAAqC,cAArC,GAAqC,GAAI,EAAE,CAAC;IACrD;;QAlEA;;;GAGC,GACD,KAACP,UAAS,IAAI,IAAI,AAAC,CAAA;QAEnB,KAAiBsB,yBAAyB,GAAG,EAAE,AAAC,CAAA;QAChD,KAAiBT,MAAM,GAAkD,EAAE,AAAC,CAAA;;CA4D7E;AAMD,OAAO,MAAMU,uBAAuB,GAAG1B,aAAa,CAAkCkB,SAAS,CAAC,CAAC;AAEjG,SAASS,0BAA0B,GAAG;IACpC,MAAMC,GAAG,GAAG3B,UAAU,CAACyB,uBAAuB,CAAC,AAAC;IAChD,IAAIE,GAAG,KAAKV,SAAS,EAAE;QACrB,MAAM,IAAIW,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,GAAG/B,OAAO,CAAC,IAAM;QAC3B,MAAM+B,MAAM,GAAqB,EAAE,AAAC;QACpCF,KAAK,aAALA,KAAK,WAAS,GAAdA,KAAAA,CAAc,GAAdA,KAAK,CAAEG,OAAO,CAAC,CAACvB,IAAI,GAAK;YACvB,MAAMwB,CAAC,GAAGH,KAAK,CAACrB,IAAI,CAAC,AAAC;YACtB,IAAIwB,CAAC,EAAE;gBACLF,MAAM,CAACtB,IAAI,CAAC,GAAGwB,CAAC,CAAC;YACnB,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAOF,MAAM,CAAC;IAChB,CAAC,EAAE;QAACD,KAAK;QAAED,KAAK;KAAC,CAAC,AAAC;IAEnB,IAAIA,KAAK,KAAKb,SAAS,EAAE;QACvB,OAAOc,KAAK,CAAC;IACf,CAAC;IAED,OAAOC,MAAM,CAAC;AAChB,CAAC;AAED,gEAAgE;AAChE,OAAO,SAASG,2BAA2B,CAACC,GAAuB,EAAsB;IACvF,MAAMC,iBAAiB,GAAGD,GAAG,GAAGjC,sBAAsB,CAACiC,GAAG,CAAC,GAAG,EAAE,AAAC;IACjE,MAAME,cAAc,GAAGT,yBAAyB,CAACQ,iBAAiB,CAAC,AAAC;IACpE,IAAI,CAACD,GAAG,EAAE,OAAOnB,SAAS,CAAC;IAC3B,OAAOb,wBAAwB,CAACgC,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 useMemo(() => {\n    return { ...templateVariableValues, ...builtinVariableValues } as VariableStateMap;\n  }, [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","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,oBAAoB,CAACD,IAAIE,MAAM,CAAC,CAACF,IAAIG,IAAI,CAAC;IACxD;IAEA;;;;GAIC,GACDC,IAAIJ,GAAqB,EAAEK,KAAoB,EAA6B;QAC1E,MAAMC,aAAa,IAAI,CAACC,WAAW,CAACP,IAAIE,MAAM;QAC9C,IAAI,CAAC,IAAI,CAACM,MAAM,CAACF,WAAW,EAAE;YAC5B,IAAI,CAACE,MAAM,CAACF,WAAW,GAAG,CAAC;QAC7B;QACA,IAAI,CAACL,oBAAoB,CAACD,IAAIE,MAAM,CAAC,CAACF,IAAIG,IAAI,CAAC,GAAGE;QAClD,OAAOA;IACT;IAEA;;;GAGC,GACDI,IAAIT,GAAqB,EAAW;QAClC,OAAO,IAAI,CAACC,oBAAoB,CAACD,IAAIE,MAAM,CAAC,CAACF,IAAIG,IAAI,CAAC,KAAKO;IAC7D;IAEA;;;GAGC,GACDC,OAAOX,GAAqB,EAAW;YAWjCY;QAVJ,MAAMC,SAAS,IAAI,CAACJ,GAAG,CAACT;QACxB,MAAMM,aAAa,IAAI,CAACC,WAAW,CAACP,IAAIE,MAAM;QAC9C,MAAMY,eAAe,IAAI,CAACN,MAAM,CAACF,WAAW;QAE5C,+BAA+B;QAC/B,IAAIQ,cAAc;YAChB,OAAOA,YAAY,CAACd,IAAIG,IAAI,CAAC;QAC/B;QAEA,0CAA0C;QAC1C,IAAIS,EAAAA,eAAAA,OAAOG,IAAI,CAACD,yBAAAA,0BAAAA,eAAgB,CAAC,gBAA7BF,mCAAAA,aAAiCI,MAAM,MAAK,GAAG;YACjD,OAAO,IAAI,CAACR,MAAM,CAACF,WAAW;QAChC;QACA,OAAOO;IACT;IAEQN,YAAYL,MAA0B,EAAU;QACtD,OAAOA,mBAAAA,oBAAAA,SAAU,IAAI,CAACe,yBAAyB;IACjD;IAEQhB,qBAAqBC,MAA0B,EAAiC;YAC/E;QAAP,OAAO,CAAA,gCAAA,IAAI,CAACM,MAAM,CAAC,IAAI,CAACD,WAAW,CAACL,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,KAAK,EAAE,GAAGL;IAElB,MAAMM,SAAShC,QAAQ;QACrB,MAAMgC,SAA2B,CAAC;QAClCF,kBAAAA,4BAAAA,MAAOG,OAAO,CAAC,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,OAAO9B,QAAQ;QACb,OAAO;YAAE,GAAGoC,sBAAsB;YAAE,GAAGC,qBAAqB;QAAC;IAC/D,GAAG;QAACD;QAAwBC;KAAsB;AACpD;AAEA,gEAAgE;AAChE,OAAO,SAASC,4BAA4BC,GAAuB;IACjE,MAAMC,oBAAoBD,MAAMrC,uBAAuBqC,OAAO,EAAE;IAChE,MAAME,iBAAiBN,kBAAkBK;IACzC,IAAI,CAACD,KAAK,OAAOtB;IACjB,OAAOd,yBAAyBoC,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"}