@perses-dev/plugin-system 0.0.0-snapshot-panel-extra-content-2-2767e21 → 0.0.0-snapshot-scatter-chart-embed-8efdfab

package/dist/runtime/TimeRangeProvider/query-params.js

@@ -13,7 +13,7 @@
 import { useMemo, useCallback, useEffect, useState } from 'react';
 import { useQueryParams } from 'use-query-params';
 import { getUnixTime, isDate } from 'date-fns';
-import { isRelativeTimeRange, isDurationString, parseDurationString } from '@perses-dev/core';
+import { isRelativeTimeRange, isDurationString } from '@perses-dev/core';
 /* Interprets an encoded string and returns either the string or null/undefined if not available */ function getEncodedValue(input, allowEmptyString) {
     if (input == null) {
         return input;
@@ -100,20 +100,17 @@ export const refreshIntervalQueryConfig = {
     ]);
 }
 /**
- * Returns time range getter and setter, set enabledURLParams to false to disable query string serialization
- */ export function useSetTimeRangeParams(initialTimeRange, enabledURLParams = true) {
+ * Returns time range getter and setter, taking the URL query params.
+ */ export function useTimeRangeParams(initialTimeRange) {
     const [query, setQuery] = useQueryParams(timeRangeQueryConfig, {
         updateType: 'replaceIn'
     });
     // determine whether initial param had previously been populated to fix back btn
     const [paramsLoaded, setParamsLoaded] = useState(false);
-    // optional fallback when app does not want query string as source of truth
-    // this occurs when enabledURLParams is set to false on TimeRangeProvider
-    const [timeRangeState, setTimeRangeState] = useState(initialTimeRange);
     const { start  } = query;
     useEffect(()=>{
         // when dashboard loaded with no params, default to dashboard duration
-        if (enabledURLParams && !paramsLoaded && !start) {
+        if (!paramsLoaded && !start) {
             if (isRelativeTimeRange(initialTimeRange)) {
                 setQuery({
                     start: initialTimeRange.pastDuration,
@@ -124,7 +121,6 @@ export const refreshIntervalQueryConfig = {
         }
     }, [
         initialTimeRange,
-        enabledURLParams,
         paramsLoaded,
         start,
         setQuery
@@ -141,12 +137,6 @@ export const refreshIntervalQueryConfig = {
     }, [
         setQuery
     ]);
-    if (!enabledURLParams) {
-        return {
-            timeRange: timeRangeState,
-            setTimeRange: setTimeRangeState
-        };
-    }
     return {
         timeRange: initialTimeRange,
         setTimeRange: setTimeRange
@@ -175,31 +165,18 @@ export const refreshIntervalQueryConfig = {
         refresh
     ]);
 }
-function getRefreshIntervalInMs(refreshInterval) {
-    let refreshIntervalInMs = 0;
-    if (refreshInterval) {
-        const refreshIntervalDuration = parseDurationString(refreshInterval);
-        if (refreshIntervalDuration && refreshIntervalDuration.seconds) {
-            refreshIntervalInMs = (refreshIntervalDuration === null || refreshIntervalDuration === void 0 ? void 0 : refreshIntervalDuration.seconds) * 1000;
-        }
-    }
-    return refreshIntervalInMs;
-}
 /**
- * Returns refresh interval getter and setter, set enabledURLParams to false to disable query string serialization
- */ export function useSetRefreshIntervalParams(initialRefreshInterval, enabledURLParams = true) {
+ * Returns refresh interval getter and setter, taking the URL query params.
+ */ export function useSetRefreshIntervalParams(initialRefreshInterval) {
     const [query, setQuery] = useQueryParams(refreshIntervalQueryConfig, {
         updateType: 'replaceIn'
     });
     // determine whether initial param had previously been populated to fix back btn
     const [paramsLoaded, setParamsLoaded] = useState(false);
-    // optional fallback when app does not want query string as source of truth
-    // this occurs when enabledURLParams is set to false on TimeRangeProvider
-    const [refreshIntervalState, setRefreshIntervalState] = useState(initialRefreshInterval);
     const { refresh  } = query;
     useEffect(()=>{
-        // when dashboard loaded with no params, default to dashboard duration
-        if (enabledURLParams && !paramsLoaded && !refresh) {
+        // when dashboard loaded with no params, default to dashboard refresh interval
+        if (!paramsLoaded && !refresh) {
             setQuery({
                 refresh: initialRefreshInterval
             });
@@ -207,7 +184,6 @@ function getRefreshIntervalInMs(refreshInterval) {
         }
     }, [
         initialRefreshInterval,
-        enabledURLParams,
         paramsLoaded,
         refresh,
         setQuery
@@ -217,17 +193,9 @@ function getRefreshIntervalInMs(refreshInterval) {
         }), [
         setQuery
     ]);
-    if (!enabledURLParams) {
-        return {
-            refreshInterval: refreshIntervalState,
-            setRefreshInterval: setRefreshIntervalState,
-            refreshIntervalInMs: getRefreshIntervalInMs(refreshIntervalState)
-        };
-    }
     return {
         refreshInterval: initialRefreshInterval,
-        setRefreshInterval: setRefreshInterval,
-        refreshIntervalInMs: getRefreshIntervalInMs(initialRefreshInterval)
+        setRefreshInterval: setRefreshInterval
     };
 }
 

package/dist/runtime/TimeRangeProvider/query-params.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/runtime/TimeRangeProvider/query-params.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 { useMemo, useCallback, useEffect, useState } from 'react';\nimport { useQueryParams, QueryParamConfig } from 'use-query-params';\nimport { getUnixTime, isDate } from 'date-fns';\nimport {\n  TimeRangeValue,\n  isRelativeTimeRange,\n  isDurationString,\n  DurationString,\n  AbsoluteTimeRange,\n  parseDurationString,\n} from '@perses-dev/core';\nimport { TimeRange } from './TimeRangeProvider';\n\nexport type TimeOptionValue = Date | DurationString | null | undefined;\n\n/* Interprets an encoded string and returns either the string or null/undefined if not available */\nfunction getEncodedValue(\n  input: string | Array<string | null> | null | undefined,\n  allowEmptyString?: boolean\n): string | null | undefined {\n  if (input == null) {\n    return input;\n  }\n  // '' or []\n  if (input.length === 0 && (!allowEmptyString || (allowEmptyString && input !== ''))) {\n    return null;\n  }\n\n  const str = input instanceof Array ? input[0] : input;\n  if (str == null) {\n    return str;\n  }\n  if (!allowEmptyString && str === '') {\n    return null;\n  }\n\n  return str;\n}\n\n/* Encodes individual TimeRangeValue as a string, depends on whether start is relative or absolute */\nexport function encodeTimeRangeValue(timeOptionValue: TimeOptionValue): string | null | undefined {\n  if (!timeOptionValue) {\n    return timeOptionValue;\n  }\n\n  if (typeof timeOptionValue === 'string') {\n    if (isDurationString(timeOptionValue)) {\n      return timeOptionValue;\n    }\n  }\n  return (getUnixTime(timeOptionValue) * 1000).toString();\n}\n\n/* Converts param input to supported relative or absolute time range format */\nexport function decodeTimeRangeValue(\n  input: string | Array<string | null> | null | undefined\n): Date | DurationString | null | undefined {\n  const paramString = getEncodedValue(input);\n  if (paramString == null) return paramString;\n  return isDurationString(paramString) ? paramString : new Date(Number(paramString));\n}\n\n/**\n * Custom TimeRangeValue param type\n * See: https://github.com/pbeshai/use-query-params/tree/master/packages/serialize-query-params#param-types\n */\nexport const TimeRangeParam: QueryParamConfig<TimeOptionValue, TimeOptionValue> = {\n  encode: encodeTimeRangeValue,\n  decode: decodeTimeRangeValue,\n  equals: (valueA: TimeOptionValue, valueB: TimeOptionValue) => {\n    if (valueA === valueB) return true;\n    if (valueA == null || valueB == null) return valueA === valueB;\n    return valueA.valueOf() === valueB.valueOf();\n  },\n};\n\nexport const timeRangeQueryConfig = {\n  start: TimeRangeParam,\n  end: TimeRangeParam,\n};\n\nexport const refreshIntervalQueryConfig = {\n  refresh: TimeRangeParam,\n};\n\n/**\n * Gets the initial time range taking into account URL params and dashboard JSON duration\n * Sets start query param if it is empty on page load\n */\nexport function useInitialTimeRange(dashboardDuration: DurationString): TimeRangeValue {\n  const [query] = useQueryParams(timeRangeQueryConfig, { updateType: 'replaceIn' });\n  const { start, end } = query;\n  return useMemo(() => {\n    let initialTimeRange: TimeRangeValue = { pastDuration: dashboardDuration };\n    if (!start) {\n      return initialTimeRange;\n    }\n    const startStr = start.toString();\n    if (isDurationString(startStr)) {\n      initialTimeRange = { pastDuration: startStr };\n    } else if (isDate(start) && isDate(end)) {\n      initialTimeRange = { start: start, end: end } as AbsoluteTimeRange;\n    }\n    return initialTimeRange;\n  }, [start, end, dashboardDuration]);\n}\n\n/**\n * Returns time range getter and setter, set enabledURLParams to false to disable query string serialization\n */\nexport function useSetTimeRangeParams(\n  initialTimeRange: TimeRangeValue,\n  enabledURLParams = true\n): Pick<TimeRange, 'timeRange' | 'setTimeRange'> {\n  const [query, setQuery] = useQueryParams(timeRangeQueryConfig, { updateType: 'replaceIn' });\n\n  // determine whether initial param had previously been populated to fix back btn\n  const [paramsLoaded, setParamsLoaded] = useState<boolean>(false);\n\n  // optional fallback when app does not want query string as source of truth\n  // this occurs when enabledURLParams is set to false on TimeRangeProvider\n  const [timeRangeState, setTimeRangeState] = useState<TimeRangeValue>(initialTimeRange);\n\n  const { start } = query;\n\n  useEffect(() => {\n    // when dashboard loaded with no params, default to dashboard duration\n    if (enabledURLParams && !paramsLoaded && !start) {\n      if (isRelativeTimeRange(initialTimeRange)) {\n        setQuery({ start: initialTimeRange.pastDuration, end: undefined });\n        setParamsLoaded(true);\n      }\n    }\n  }, [initialTimeRange, enabledURLParams, paramsLoaded, start, setQuery]);\n\n  const setTimeRange: TimeRange['setTimeRange'] = useCallback(\n    (value: TimeRangeValue) => {\n      if (isRelativeTimeRange(value)) {\n        setQuery({ start: value.pastDuration, end: undefined });\n      } else {\n        setQuery(value);\n      }\n    },\n    [setQuery]\n  );\n\n  if (!enabledURLParams) {\n    return { timeRange: timeRangeState, setTimeRange: setTimeRangeState };\n  }\n  return { timeRange: initialTimeRange, setTimeRange: setTimeRange };\n}\n\n/**\n * Gets the initial refresh interval taking into account URL params and dashboard JSON duration\n * Sets refresh query param if it is empty on page load\n */\nexport function useInitialRefreshInterval(dashboardDuration: DurationString): DurationString {\n  const [query] = useQueryParams(refreshIntervalQueryConfig, { updateType: 'replaceIn' });\n  const { refresh } = query;\n  return useMemo(() => {\n    let initialTimeRange: DurationString = dashboardDuration;\n    if (!refresh) {\n      return initialTimeRange;\n    }\n    const startStr = refresh.toString();\n    if (isDurationString(startStr)) {\n      initialTimeRange = startStr;\n    }\n    return initialTimeRange;\n  }, [dashboardDuration, refresh]);\n}\n\nfunction getRefreshIntervalInMs(refreshInterval?: DurationString) {\n  let refreshIntervalInMs = 0;\n  if (refreshInterval) {\n    const refreshIntervalDuration = parseDurationString(refreshInterval);\n    if (refreshIntervalDuration && refreshIntervalDuration.seconds) {\n      refreshIntervalInMs = refreshIntervalDuration?.seconds * 1000;\n    }\n  }\n  return refreshIntervalInMs;\n}\n\n/**\n * Returns refresh interval getter and setter, set enabledURLParams to false to disable query string serialization\n */\nexport function useSetRefreshIntervalParams(\n  initialRefreshInterval?: DurationString,\n  enabledURLParams = true\n): Pick<TimeRange, 'refreshInterval' | 'setRefreshInterval' | 'refreshIntervalInMs'> {\n  const [query, setQuery] = useQueryParams(refreshIntervalQueryConfig, { updateType: 'replaceIn' });\n\n  // determine whether initial param had previously been populated to fix back btn\n  const [paramsLoaded, setParamsLoaded] = useState<boolean>(false);\n\n  // optional fallback when app does not want query string as source of truth\n  // this occurs when enabledURLParams is set to false on TimeRangeProvider\n  const [refreshIntervalState, setRefreshIntervalState] = useState<DurationString | undefined>(initialRefreshInterval);\n\n  const { refresh } = query;\n\n  useEffect(() => {\n    // when dashboard loaded with no params, default to dashboard duration\n    if (enabledURLParams && !paramsLoaded && !refresh) {\n      setQuery({ refresh: initialRefreshInterval });\n      setParamsLoaded(true);\n    }\n  }, [initialRefreshInterval, enabledURLParams, paramsLoaded, refresh, setQuery]);\n\n  const setRefreshInterval: TimeRange['setRefreshInterval'] = useCallback(\n    (refresh: DurationString) => setQuery({ refresh }),\n    [setQuery]\n  );\n\n  if (!enabledURLParams) {\n    return {\n      refreshInterval: refreshIntervalState,\n      setRefreshInterval: setRefreshIntervalState,\n      refreshIntervalInMs: getRefreshIntervalInMs(refreshIntervalState),\n    };\n  }\n  return {\n    refreshInterval: initialRefreshInterval,\n    setRefreshInterval: setRefreshInterval,\n    refreshIntervalInMs: getRefreshIntervalInMs(initialRefreshInterval),\n  };\n}\n"],"names":["useMemo","useCallback","useEffect","useState","useQueryParams","getUnixTime","isDate","isRelativeTimeRange","isDurationString","parseDurationString","getEncodedValue","input","allowEmptyString","length","str","Array","encodeTimeRangeValue","timeOptionValue","toString","decodeTimeRangeValue","paramString","Date","Number","TimeRangeParam","encode","decode","equals","valueA","valueB","valueOf","timeRangeQueryConfig","start","end","refreshIntervalQueryConfig","refresh","useInitialTimeRange","dashboardDuration","query","updateType","initialTimeRange","pastDuration","startStr","useSetTimeRangeParams","enabledURLParams","setQuery","paramsLoaded","setParamsLoaded","timeRangeState","setTimeRangeState","undefined","setTimeRange","value","timeRange","useInitialRefreshInterval","getRefreshIntervalInMs","refreshInterval","refreshIntervalInMs","refreshIntervalDuration","seconds","useSetRefreshIntervalParams","initialRefreshInterval","refreshIntervalState","setRefreshIntervalState","setRefreshInterval"],"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,OAAO,EAAEC,WAAW,EAAEC,SAAS,EAAEC,QAAQ,QAAQ,OAAO,CAAC;AAClE,SAASC,cAAc,QAA0B,kBAAkB,CAAC;AACpE,SAASC,WAAW,EAAEC,MAAM,QAAQ,UAAU,CAAC;AAC/C,SAEEC,mBAAmB,EACnBC,gBAAgB,EAGhBC,mBAAmB,QACd,kBAAkB,CAAC;AAK1B,iGAAiG,GACjG,SAASC,eAAe,CACtBC,KAAuD,EACvDC,gBAA0B,EACC;IAC3B,IAAID,KAAK,IAAI,IAAI,EAAE;QACjB,OAAOA,KAAK,CAAC;IACf,CAAC;IACD,WAAW;IACX,IAAIA,KAAK,CAACE,MAAM,KAAK,CAAC,IAAK,CAAA,CAACD,gBAAgB,IAAKA,gBAAgB,IAAID,KAAK,KAAK,EAAE,AAAC,CAAA,AAAC,EAAE;QACnF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAMG,GAAG,GAAGH,KAAK,YAAYI,KAAK,GAAGJ,KAAK,CAAC,CAAC,CAAC,GAAGA,KAAK,AAAC;IACtD,IAAIG,GAAG,IAAI,IAAI,EAAE;QACf,OAAOA,GAAG,CAAC;IACb,CAAC;IACD,IAAI,CAACF,gBAAgB,IAAIE,GAAG,KAAK,EAAE,EAAE;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAOA,GAAG,CAAC;AACb,CAAC;AAED,mGAAmG,GACnG,OAAO,SAASE,oBAAoB,CAACC,eAAgC,EAA6B;IAChG,IAAI,CAACA,eAAe,EAAE;QACpB,OAAOA,eAAe,CAAC;IACzB,CAAC;IAED,IAAI,OAAOA,eAAe,KAAK,QAAQ,EAAE;QACvC,IAAIT,gBAAgB,CAACS,eAAe,CAAC,EAAE;YACrC,OAAOA,eAAe,CAAC;QACzB,CAAC;IACH,CAAC;IACD,OAAO,AAACZ,CAAAA,WAAW,CAACY,eAAe,CAAC,GAAG,IAAI,CAAA,CAAEC,QAAQ,EAAE,CAAC;AAC1D,CAAC;AAED,4EAA4E,GAC5E,OAAO,SAASC,oBAAoB,CAClCR,KAAuD,EACb;IAC1C,MAAMS,WAAW,GAAGV,eAAe,CAACC,KAAK,CAAC,AAAC;IAC3C,IAAIS,WAAW,IAAI,IAAI,EAAE,OAAOA,WAAW,CAAC;IAC5C,OAAOZ,gBAAgB,CAACY,WAAW,CAAC,GAAGA,WAAW,GAAG,IAAIC,IAAI,CAACC,MAAM,CAACF,WAAW,CAAC,CAAC,CAAC;AACrF,CAAC;AAED;;;CAGC,GACD,OAAO,MAAMG,cAAc,GAAuD;IAChFC,MAAM,EAAER,oBAAoB;IAC5BS,MAAM,EAAEN,oBAAoB;IAC5BO,MAAM,EAAE,CAACC,MAAuB,EAAEC,MAAuB,GAAK;QAC5D,IAAID,MAAM,KAAKC,MAAM,EAAE,OAAO,IAAI,CAAC;QACnC,IAAID,MAAM,IAAI,IAAI,IAAIC,MAAM,IAAI,IAAI,EAAE,OAAOD,MAAM,KAAKC,MAAM,CAAC;QAC/D,OAAOD,MAAM,CAACE,OAAO,EAAE,KAAKD,MAAM,CAACC,OAAO,EAAE,CAAC;IAC/C,CAAC;CACF,CAAC;AAEF,OAAO,MAAMC,oBAAoB,GAAG;IAClCC,KAAK,EAAER,cAAc;IACrBS,GAAG,EAAET,cAAc;CACpB,CAAC;AAEF,OAAO,MAAMU,0BAA0B,GAAG;IACxCC,OAAO,EAAEX,cAAc;CACxB,CAAC;AAEF;;;CAGC,GACD,OAAO,SAASY,mBAAmB,CAACC,iBAAiC,EAAkB;IACrF,MAAM,CAACC,KAAK,CAAC,GAAGjC,cAAc,CAAC0B,oBAAoB,EAAE;QAAEQ,UAAU,EAAE,WAAW;KAAE,CAAC,AAAC;IAClF,MAAM,EAAEP,KAAK,CAAA,EAAEC,GAAG,CAAA,EAAE,GAAGK,KAAK,AAAC;IAC7B,OAAOrC,OAAO,CAAC,IAAM;QACnB,IAAIuC,gBAAgB,GAAmB;YAAEC,YAAY,EAAEJ,iBAAiB;SAAE,AAAC;QAC3E,IAAI,CAACL,KAAK,EAAE;YACV,OAAOQ,gBAAgB,CAAC;QAC1B,CAAC;QACD,MAAME,QAAQ,GAAGV,KAAK,CAACb,QAAQ,EAAE,AAAC;QAClC,IAAIV,gBAAgB,CAACiC,QAAQ,CAAC,EAAE;YAC9BF,gBAAgB,GAAG;gBAAEC,YAAY,EAAEC,QAAQ;aAAE,CAAC;QAChD,OAAO,IAAInC,MAAM,CAACyB,KAAK,CAAC,IAAIzB,MAAM,CAAC0B,GAAG,CAAC,EAAE;YACvCO,gBAAgB,GAAG;gBAAER,KAAK,EAAEA,KAAK;gBAAEC,GAAG,EAAEA,GAAG;aAAE,AAAqB,CAAC;QACrE,CAAC;QACD,OAAOO,gBAAgB,CAAC;IAC1B,CAAC,EAAE;QAACR,KAAK;QAAEC,GAAG;QAAEI,iBAAiB;KAAC,CAAC,CAAC;AACtC,CAAC;AAED;;CAEC,GACD,OAAO,SAASM,qBAAqB,CACnCH,gBAAgC,EAChCI,gBAAgB,GAAG,IAAI,EACwB;IAC/C,MAAM,CAACN,KAAK,EAAEO,QAAQ,CAAC,GAAGxC,cAAc,CAAC0B,oBAAoB,EAAE;QAAEQ,UAAU,EAAE,WAAW;KAAE,CAAC,AAAC;IAE5F,gFAAgF;IAChF,MAAM,CAACO,YAAY,EAAEC,eAAe,CAAC,GAAG3C,QAAQ,CAAU,KAAK,CAAC,AAAC;IAEjE,2EAA2E;IAC3E,yEAAyE;IACzE,MAAM,CAAC4C,cAAc,EAAEC,iBAAiB,CAAC,GAAG7C,QAAQ,CAAiBoC,gBAAgB,CAAC,AAAC;IAEvF,MAAM,EAAER,KAAK,CAAA,EAAE,GAAGM,KAAK,AAAC;IAExBnC,SAAS,CAAC,IAAM;QACd,sEAAsE;QACtE,IAAIyC,gBAAgB,IAAI,CAACE,YAAY,IAAI,CAACd,KAAK,EAAE;YAC/C,IAAIxB,mBAAmB,CAACgC,gBAAgB,CAAC,EAAE;gBACzCK,QAAQ,CAAC;oBAAEb,KAAK,EAAEQ,gBAAgB,CAACC,YAAY;oBAAER,GAAG,EAAEiB,SAAS;iBAAE,CAAC,CAAC;gBACnEH,eAAe,CAAC,IAAI,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;IACH,CAAC,EAAE;QAACP,gBAAgB;QAAEI,gBAAgB;QAAEE,YAAY;QAAEd,KAAK;QAAEa,QAAQ;KAAC,CAAC,CAAC;IAExE,MAAMM,YAAY,GAA8BjD,WAAW,CACzD,CAACkD,KAAqB,GAAK;QACzB,IAAI5C,mBAAmB,CAAC4C,KAAK,CAAC,EAAE;YAC9BP,QAAQ,CAAC;gBAAEb,KAAK,EAAEoB,KAAK,CAACX,YAAY;gBAAER,GAAG,EAAEiB,SAAS;aAAE,CAAC,CAAC;QAC1D,OAAO;YACLL,QAAQ,CAACO,KAAK,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,EACD;QAACP,QAAQ;KAAC,CACX,AAAC;IAEF,IAAI,CAACD,gBAAgB,EAAE;QACrB,OAAO;YAAES,SAAS,EAAEL,cAAc;YAAEG,YAAY,EAAEF,iBAAiB;SAAE,CAAC;IACxE,CAAC;IACD,OAAO;QAAEI,SAAS,EAAEb,gBAAgB;QAAEW,YAAY,EAAEA,YAAY;KAAE,CAAC;AACrE,CAAC;AAED;;;CAGC,GACD,OAAO,SAASG,yBAAyB,CAACjB,iBAAiC,EAAkB;IAC3F,MAAM,CAACC,KAAK,CAAC,GAAGjC,cAAc,CAAC6B,0BAA0B,EAAE;QAAEK,UAAU,EAAE,WAAW;KAAE,CAAC,AAAC;IACxF,MAAM,EAAEJ,OAAO,CAAA,EAAE,GAAGG,KAAK,AAAC;IAC1B,OAAOrC,OAAO,CAAC,IAAM;QACnB,IAAIuC,gBAAgB,GAAmBH,iBAAiB,AAAC;QACzD,IAAI,CAACF,OAAO,EAAE;YACZ,OAAOK,gBAAgB,CAAC;QAC1B,CAAC;QACD,MAAME,QAAQ,GAAGP,OAAO,CAAChB,QAAQ,EAAE,AAAC;QACpC,IAAIV,gBAAgB,CAACiC,QAAQ,CAAC,EAAE;YAC9BF,gBAAgB,GAAGE,QAAQ,CAAC;QAC9B,CAAC;QACD,OAAOF,gBAAgB,CAAC;IAC1B,CAAC,EAAE;QAACH,iBAAiB;QAAEF,OAAO;KAAC,CAAC,CAAC;AACnC,CAAC;AAED,SAASoB,sBAAsB,CAACC,eAAgC,EAAE;IAChE,IAAIC,mBAAmB,GAAG,CAAC,AAAC;IAC5B,IAAID,eAAe,EAAE;QACnB,MAAME,uBAAuB,GAAGhD,mBAAmB,CAAC8C,eAAe,CAAC,AAAC;QACrE,IAAIE,uBAAuB,IAAIA,uBAAuB,CAACC,OAAO,EAAE;YAC9DF,mBAAmB,GAAGC,CAAAA,uBAAuB,aAAvBA,uBAAuB,WAAS,GAAhCA,KAAAA,CAAgC,GAAhCA,uBAAuB,CAAEC,OAAO,CAAA,GAAG,IAAI,CAAC;QAChE,CAAC;IACH,CAAC;IACD,OAAOF,mBAAmB,CAAC;AAC7B,CAAC;AAED;;CAEC,GACD,OAAO,SAASG,2BAA2B,CACzCC,sBAAuC,EACvCjB,gBAAgB,GAAG,IAAI,EAC4D;IACnF,MAAM,CAACN,KAAK,EAAEO,QAAQ,CAAC,GAAGxC,cAAc,CAAC6B,0BAA0B,EAAE;QAAEK,UAAU,EAAE,WAAW;KAAE,CAAC,AAAC;IAElG,gFAAgF;IAChF,MAAM,CAACO,YAAY,EAAEC,eAAe,CAAC,GAAG3C,QAAQ,CAAU,KAAK,CAAC,AAAC;IAEjE,2EAA2E;IAC3E,yEAAyE;IACzE,MAAM,CAAC0D,oBAAoB,EAAEC,uBAAuB,CAAC,GAAG3D,QAAQ,CAA6ByD,sBAAsB,CAAC,AAAC;IAErH,MAAM,EAAE1B,OAAO,CAAA,EAAE,GAAGG,KAAK,AAAC;IAE1BnC,SAAS,CAAC,IAAM;QACd,sEAAsE;QACtE,IAAIyC,gBAAgB,IAAI,CAACE,YAAY,IAAI,CAACX,OAAO,EAAE;YACjDU,QAAQ,CAAC;gBAAEV,OAAO,EAAE0B,sBAAsB;aAAE,CAAC,CAAC;YAC9Cd,eAAe,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;IACH,CAAC,EAAE;QAACc,sBAAsB;QAAEjB,gBAAgB;QAAEE,YAAY;QAAEX,OAAO;QAAEU,QAAQ;KAAC,CAAC,CAAC;IAEhF,MAAMmB,kBAAkB,GAAoC9D,WAAW,CACrE,CAACiC,OAAuB,GAAKU,QAAQ,CAAC;YAAEV,OAAO;SAAE,CAAC,EAClD;QAACU,QAAQ;KAAC,CACX,AAAC;IAEF,IAAI,CAACD,gBAAgB,EAAE;QACrB,OAAO;YACLY,eAAe,EAAEM,oBAAoB;YACrCE,kBAAkB,EAAED,uBAAuB;YAC3CN,mBAAmB,EAAEF,sBAAsB,CAACO,oBAAoB,CAAC;SAClE,CAAC;IACJ,CAAC;IACD,OAAO;QACLN,eAAe,EAAEK,sBAAsB;QACvCG,kBAAkB,EAAEA,kBAAkB;QACtCP,mBAAmB,EAAEF,sBAAsB,CAACM,sBAAsB,CAAC;KACpE,CAAC;AACJ,CAAC"}
+{"version":3,"sources":["../../../src/runtime/TimeRangeProvider/query-params.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 { useMemo, useCallback, useEffect, useState } from 'react';\nimport { useQueryParams, QueryParamConfig } from 'use-query-params';\nimport { getUnixTime, isDate } from 'date-fns';\nimport {\n  TimeRangeValue,\n  isRelativeTimeRange,\n  isDurationString,\n  DurationString,\n  AbsoluteTimeRange,\n} from '@perses-dev/core';\nimport { TimeRange } from './TimeRangeProvider';\n\nexport type TimeOptionValue = Date | DurationString | null | undefined;\n\n/* Interprets an encoded string and returns either the string or null/undefined if not available */\nfunction getEncodedValue(\n  input: string | Array<string | null> | null | undefined,\n  allowEmptyString?: boolean\n): string | null | undefined {\n  if (input == null) {\n    return input;\n  }\n  // '' or []\n  if (input.length === 0 && (!allowEmptyString || (allowEmptyString && input !== ''))) {\n    return null;\n  }\n\n  const str = input instanceof Array ? input[0] : input;\n  if (str == null) {\n    return str;\n  }\n  if (!allowEmptyString && str === '') {\n    return null;\n  }\n\n  return str;\n}\n\n/* Encodes individual TimeRangeValue as a string, depends on whether start is relative or absolute */\nexport function encodeTimeRangeValue(timeOptionValue: TimeOptionValue): string | null | undefined {\n  if (!timeOptionValue) {\n    return timeOptionValue;\n  }\n\n  if (typeof timeOptionValue === 'string') {\n    if (isDurationString(timeOptionValue)) {\n      return timeOptionValue;\n    }\n  }\n  return (getUnixTime(timeOptionValue) * 1000).toString();\n}\n\n/* Converts param input to supported relative or absolute time range format */\nexport function decodeTimeRangeValue(\n  input: string | Array<string | null> | null | undefined\n): Date | DurationString | null | undefined {\n  const paramString = getEncodedValue(input);\n  if (paramString == null) return paramString;\n  return isDurationString(paramString) ? paramString : new Date(Number(paramString));\n}\n\n/**\n * Custom TimeRangeValue param type\n * See: https://github.com/pbeshai/use-query-params/tree/master/packages/serialize-query-params#param-types\n */\nexport const TimeRangeParam: QueryParamConfig<TimeOptionValue, TimeOptionValue> = {\n  encode: encodeTimeRangeValue,\n  decode: decodeTimeRangeValue,\n  equals: (valueA: TimeOptionValue, valueB: TimeOptionValue) => {\n    if (valueA === valueB) return true;\n    if (valueA == null || valueB == null) return valueA === valueB;\n    return valueA.valueOf() === valueB.valueOf();\n  },\n};\n\nexport const timeRangeQueryConfig = {\n  start: TimeRangeParam,\n  end: TimeRangeParam,\n};\n\nexport const refreshIntervalQueryConfig = {\n  refresh: TimeRangeParam,\n};\n\n/**\n * Gets the initial time range taking into account URL params and dashboard JSON duration\n * Sets start query param if it is empty on page load\n */\nexport function useInitialTimeRange(dashboardDuration: DurationString): TimeRangeValue {\n  const [query] = useQueryParams(timeRangeQueryConfig, { updateType: 'replaceIn' });\n  const { start, end } = query;\n  return useMemo(() => {\n    let initialTimeRange: TimeRangeValue = { pastDuration: dashboardDuration };\n    if (!start) {\n      return initialTimeRange;\n    }\n    const startStr = start.toString();\n    if (isDurationString(startStr)) {\n      initialTimeRange = { pastDuration: startStr };\n    } else if (isDate(start) && isDate(end)) {\n      initialTimeRange = { start: start, end: end } as AbsoluteTimeRange;\n    }\n    return initialTimeRange;\n  }, [start, end, dashboardDuration]);\n}\n\n/**\n * Returns time range getter and setter, taking the URL query params.\n */\nexport function useTimeRangeParams(initialTimeRange: TimeRangeValue): Pick<TimeRange, 'timeRange' | 'setTimeRange'> {\n  const [query, setQuery] = useQueryParams(timeRangeQueryConfig, { updateType: 'replaceIn' });\n\n  // determine whether initial param had previously been populated to fix back btn\n  const [paramsLoaded, setParamsLoaded] = useState<boolean>(false);\n\n  const { start } = query;\n\n  useEffect(() => {\n    // when dashboard loaded with no params, default to dashboard duration\n    if (!paramsLoaded && !start) {\n      if (isRelativeTimeRange(initialTimeRange)) {\n        setQuery({ start: initialTimeRange.pastDuration, end: undefined });\n        setParamsLoaded(true);\n      }\n    }\n  }, [initialTimeRange, paramsLoaded, start, setQuery]);\n\n  const setTimeRange: TimeRange['setTimeRange'] = useCallback(\n    (value: TimeRangeValue) => {\n      if (isRelativeTimeRange(value)) {\n        setQuery({ start: value.pastDuration, end: undefined });\n      } else {\n        setQuery(value);\n      }\n    },\n    [setQuery]\n  );\n\n  return { timeRange: initialTimeRange, setTimeRange: setTimeRange };\n}\n\n/**\n * Gets the initial refresh interval taking into account URL params and dashboard JSON duration\n * Sets refresh query param if it is empty on page load\n */\nexport function useInitialRefreshInterval(dashboardDuration: DurationString): DurationString {\n  const [query] = useQueryParams(refreshIntervalQueryConfig, { updateType: 'replaceIn' });\n  const { refresh } = query;\n  return useMemo(() => {\n    let initialTimeRange: DurationString = dashboardDuration;\n    if (!refresh) {\n      return initialTimeRange;\n    }\n    const startStr = refresh.toString();\n    if (isDurationString(startStr)) {\n      initialTimeRange = startStr;\n    }\n    return initialTimeRange;\n  }, [dashboardDuration, refresh]);\n}\n\n/**\n * Returns refresh interval getter and setter, taking the URL query params.\n */\nexport function useSetRefreshIntervalParams(\n  initialRefreshInterval?: DurationString\n): Pick<TimeRange, 'refreshInterval' | 'setRefreshInterval'> {\n  const [query, setQuery] = useQueryParams(refreshIntervalQueryConfig, { updateType: 'replaceIn' });\n\n  // determine whether initial param had previously been populated to fix back btn\n  const [paramsLoaded, setParamsLoaded] = useState<boolean>(false);\n\n  const { refresh } = query;\n\n  useEffect(() => {\n    // when dashboard loaded with no params, default to dashboard refresh interval\n    if (!paramsLoaded && !refresh) {\n      setQuery({ refresh: initialRefreshInterval });\n      setParamsLoaded(true);\n    }\n  }, [initialRefreshInterval, paramsLoaded, refresh, setQuery]);\n\n  const setRefreshInterval: TimeRange['setRefreshInterval'] = useCallback(\n    (refresh: DurationString) => setQuery({ refresh }),\n    [setQuery]\n  );\n\n  return {\n    refreshInterval: initialRefreshInterval,\n    setRefreshInterval: setRefreshInterval,\n  };\n}\n"],"names":["useMemo","useCallback","useEffect","useState","useQueryParams","getUnixTime","isDate","isRelativeTimeRange","isDurationString","getEncodedValue","input","allowEmptyString","length","str","Array","encodeTimeRangeValue","timeOptionValue","toString","decodeTimeRangeValue","paramString","Date","Number","TimeRangeParam","encode","decode","equals","valueA","valueB","valueOf","timeRangeQueryConfig","start","end","refreshIntervalQueryConfig","refresh","useInitialTimeRange","dashboardDuration","query","updateType","initialTimeRange","pastDuration","startStr","useTimeRangeParams","setQuery","paramsLoaded","setParamsLoaded","undefined","setTimeRange","value","timeRange","useInitialRefreshInterval","useSetRefreshIntervalParams","initialRefreshInterval","setRefreshInterval","refreshInterval"],"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,OAAO,EAAEC,WAAW,EAAEC,SAAS,EAAEC,QAAQ,QAAQ,QAAQ;AAClE,SAASC,cAAc,QAA0B,mBAAmB;AACpE,SAASC,WAAW,EAAEC,MAAM,QAAQ,WAAW;AAC/C,SAEEC,mBAAmB,EACnBC,gBAAgB,QAGX,mBAAmB;AAK1B,iGAAiG,GACjG,SAASC,gBACPC,KAAuD,EACvDC,gBAA0B;IAE1B,IAAID,SAAS,MAAM;QACjB,OAAOA;IACT;IACA,WAAW;IACX,IAAIA,MAAME,WAAW,KAAM,CAAA,CAACD,oBAAqBA,oBAAoBD,UAAU,EAAE,GAAI;QACnF,OAAO;IACT;IAEA,MAAMG,MAAMH,iBAAiBI,QAAQJ,KAAK,CAAC,EAAE,GAAGA;IAChD,IAAIG,OAAO,MAAM;QACf,OAAOA;IACT;IACA,IAAI,CAACF,oBAAoBE,QAAQ,IAAI;QACnC,OAAO;IACT;IAEA,OAAOA;AACT;AAEA,mGAAmG,GACnG,OAAO,SAASE,qBAAqBC,eAAgC;IACnE,IAAI,CAACA,iBAAiB;QACpB,OAAOA;IACT;IAEA,IAAI,OAAOA,oBAAoB,UAAU;QACvC,IAAIR,iBAAiBQ,kBAAkB;YACrC,OAAOA;QACT;IACF;IACA,OAAO,AAACX,CAAAA,YAAYW,mBAAmB,IAAG,EAAGC;AAC/C;AAEA,4EAA4E,GAC5E,OAAO,SAASC,qBACdR,KAAuD;IAEvD,MAAMS,cAAcV,gBAAgBC;IACpC,IAAIS,eAAe,MAAM,OAAOA;IAChC,OAAOX,iBAAiBW,eAAeA,cAAc,IAAIC,KAAKC,OAAOF;AACvE;AAEA;;;CAGC,GACD,OAAO,MAAMG,iBAAqE;IAChFC,QAAQR;IACRS,QAAQN;IACRO,QAAQ,CAACC,QAAyBC;QAChC,IAAID,WAAWC,QAAQ,OAAO;QAC9B,IAAID,UAAU,QAAQC,UAAU,MAAM,OAAOD,WAAWC;QACxD,OAAOD,OAAOE,cAAcD,OAAOC;IACrC;AACF,EAAE;AAEF,OAAO,MAAMC,uBAAuB;IAClCC,OAAOR;IACPS,KAAKT;AACP,EAAE;AAEF,OAAO,MAAMU,6BAA6B;IACxCC,SAASX;AACX,EAAE;AAEF;;;CAGC,GACD,OAAO,SAASY,oBAAoBC,iBAAiC;IACnE,MAAM,CAACC,MAAM,GAAGhC,eAAeyB,sBAAsB;QAAEQ,YAAY;IAAY;IAC/E,MAAM,EAAEP,MAAK,EAAEC,IAAG,EAAE,GAAGK;IACvB,OAAOpC,QAAQ;QACb,IAAIsC,mBAAmC;YAAEC,cAAcJ;QAAkB;QACzE,IAAI,CAACL,OAAO;YACV,OAAOQ;QACT;QACA,MAAME,WAAWV,MAAMb;QACvB,IAAIT,iBAAiBgC,WAAW;YAC9BF,mBAAmB;gBAAEC,cAAcC;YAAS;QAC9C,OAAO,IAAIlC,OAAOwB,UAAUxB,OAAOyB,MAAM;YACvCO,mBAAmB;gBAAER,OAAOA;gBAAOC,KAAKA;YAAI;QAC9C;QACA,OAAOO;IACT,GAAG;QAACR;QAAOC;QAAKI;KAAkB;AACpC;AAEA;;CAEC,GACD,OAAO,SAASM,mBAAmBH,gBAAgC;IACjE,MAAM,CAACF,OAAOM,SAAS,GAAGtC,eAAeyB,sBAAsB;QAAEQ,YAAY;IAAY;IAEzF,gFAAgF;IAChF,MAAM,CAACM,cAAcC,gBAAgB,GAAGzC,SAAkB;IAE1D,MAAM,EAAE2B,MAAK,EAAE,GAAGM;IAElBlC,UAAU;QACR,sEAAsE;QACtE,IAAI,CAACyC,gBAAgB,CAACb,OAAO;YAC3B,IAAIvB,oBAAoB+B,mBAAmB;gBACzCI,SAAS;oBAAEZ,OAAOQ,iBAAiBC;oBAAcR,KAAKc;gBAAU;gBAChED,gBAAgB;YAClB;QACF;IACF,GAAG;QAACN;QAAkBK;QAAcb;QAAOY;KAAS;IAEpD,MAAMI,eAA0C7C,YAC9C,CAAC8C;QACC,IAAIxC,oBAAoBwC,QAAQ;YAC9BL,SAAS;gBAAEZ,OAAOiB,MAAMR;gBAAcR,KAAKc;YAAU;QACvD,OAAO;YACLH,SAASK;QACX;IACF,GACA;QAACL;KAAS;IAGZ,OAAO;QAAEM,WAAWV;QAAkBQ,cAAcA;IAAa;AACnE;AAEA;;;CAGC,GACD,OAAO,SAASG,0BAA0Bd,iBAAiC;IACzE,MAAM,CAACC,MAAM,GAAGhC,eAAe4B,4BAA4B;QAAEK,YAAY;IAAY;IACrF,MAAM,EAAEJ,QAAO,EAAE,GAAGG;IACpB,OAAOpC,QAAQ;QACb,IAAIsC,mBAAmCH;QACvC,IAAI,CAACF,SAAS;YACZ,OAAOK;QACT;QACA,MAAME,WAAWP,QAAQhB;QACzB,IAAIT,iBAAiBgC,WAAW;YAC9BF,mBAAmBE;QACrB;QACA,OAAOF;IACT,GAAG;QAACH;QAAmBF;KAAQ;AACjC;AAEA;;CAEC,GACD,OAAO,SAASiB,4BACdC,sBAAuC;IAEvC,MAAM,CAACf,OAAOM,SAAS,GAAGtC,eAAe4B,4BAA4B;QAAEK,YAAY;IAAY;IAE/F,gFAAgF;IAChF,MAAM,CAACM,cAAcC,gBAAgB,GAAGzC,SAAkB;IAE1D,MAAM,EAAE8B,QAAO,EAAE,GAAGG;IAEpBlC,UAAU;QACR,8EAA8E;QAC9E,IAAI,CAACyC,gBAAgB,CAACV,SAAS;YAC7BS,SAAS;gBAAET,SAASkB;YAAuB;YAC3CP,gBAAgB;QAClB;IACF,GAAG;QAACO;QAAwBR;QAAcV;QAASS;KAAS;IAE5D,MAAMU,qBAAsDnD,YAC1D,CAACgC,UAA4BS,SAAS;YAAET;QAAQ,IAChD;QAACS;KAAS;IAGZ,OAAO;QACLW,iBAAiBF;QACjBC,oBAAoBA;IACtB;AACF"}

package/dist/runtime/TimeRangeProvider/refresh-interval.d.ts

@@ -0,0 +1,7 @@
+import { DurationString } from '@perses-dev/core';
+/**
+ * Utils function to transform a refresh interval in {@link DurationString} format into a number of ms.
+ * @param refreshInterval
+ */
+export declare function getRefreshIntervalInMs(refreshInterval?: DurationString): number;
+//# sourceMappingURL=refresh-interval.d.ts.map

package/dist/runtime/TimeRangeProvider/refresh-interval.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refresh-interval.d.ts","sourceRoot":"","sources":["../../../src/runtime/TimeRangeProvider/refresh-interval.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,cAAc,EAAuB,MAAM,kBAAkB,CAAC;AAGvE;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,eAAe,CAAC,EAAE,cAAc,UAKtE"}

package/dist/runtime/TimeRangeProvider/refresh-interval.js

@@ -0,0 +1,25 @@
+// Copyright 2023 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import { parseDurationString } from '@perses-dev/core';
+import { milliseconds } from 'date-fns';
+/**
+ * Utils function to transform a refresh interval in {@link DurationString} format into a number of ms.
+ * @param refreshInterval
+ */ export function getRefreshIntervalInMs(refreshInterval) {
+    if (refreshInterval !== undefined && refreshInterval !== null) {
+        return milliseconds(parseDurationString(refreshInterval));
+    }
+    return 0;
+}
+
+//# sourceMappingURL=refresh-interval.js.map

package/dist/runtime/TimeRangeProvider/refresh-interval.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/runtime/TimeRangeProvider/refresh-interval.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 { DurationString, parseDurationString } from '@perses-dev/core';\nimport { milliseconds } from 'date-fns';\n\n/**\n * Utils function to transform a refresh interval in {@link DurationString} format into a number of ms.\n * @param refreshInterval\n */\nexport function getRefreshIntervalInMs(refreshInterval?: DurationString) {\n  if (refreshInterval !== undefined && refreshInterval !== null) {\n    return milliseconds(parseDurationString(refreshInterval));\n  }\n  return 0;\n}\n"],"names":["parseDurationString","milliseconds","getRefreshIntervalInMs","refreshInterval","undefined"],"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,SAAyBA,mBAAmB,QAAQ,mBAAmB;AACvE,SAASC,YAAY,QAAQ,WAAW;AAExC;;;CAGC,GACD,OAAO,SAASC,uBAAuBC,eAAgC;IACrE,IAAIA,oBAAoBC,aAAaD,oBAAoB,MAAM;QAC7D,OAAOF,aAAaD,oBAAoBG;IAC1C;IACA,OAAO;AACT"}

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

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { BuiltinVariableDefinition } from '@perses-dev/core';
+import { VariableStateMap } from './template-variables';
+export declare type BuiltinVariableSrv = {
+    variables: BuiltinVariableDefinition[];
+};
+export declare const BuiltinVariableContext: import("react").Context<BuiltinVariableSrv | undefined>;
+export declare function useBuiltinVariableContext(): BuiltinVariableSrv;
+export declare function useBuiltinVariableValues(names?: string[]): VariableStateMap;
+export declare function useBuiltinVariableDefinitions(): BuiltinVariableDefinition[];
+//# sourceMappingURL=builtin-variables.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"builtin-variables.d.ts","sourceRoot":"","sources":["../../src/runtime/builtin-variables.ts"],"names":[],"mappings":";AAcA,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,oBAAY,kBAAkB,GAAG;IAC/B,SAAS,EAAE,yBAAyB,EAAE,CAAC;CACxC,CAAC;AAEF,eAAO,MAAM,sBAAsB,yDAA2D,CAAC;AAE/F,wBAAgB,yBAAyB,uBAMxC;AAED,wBAAgB,wBAAwB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,gBAAgB,CA0B3E;AAED,wBAAgB,6BAA6B,IAAI,yBAAyB,EAAE,CAG3E"}

package/dist/runtime/builtin-variables.js

@@ -0,0 +1,59 @@
+// Copyright 2023 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import { createContext, useContext, useMemo } from 'react';
+export const BuiltinVariableContext = createContext(undefined);
+export function useBuiltinVariableContext() {
+    const ctx = useContext(BuiltinVariableContext);
+    if (ctx === undefined) {
+        throw new Error('No BuiltinVariableContext found. Did you forget a Provider?');
+    }
+    return ctx;
+}
+export function useBuiltinVariableValues(names) {
+    const { variables  } = useBuiltinVariableContext();
+    const states = useMemo(()=>{
+        const values = {};
+        for (const variable of variables){
+            values[variable.spec.name] = {
+                loading: false,
+                value: variable.spec.value()
+            };
+        }
+        return values;
+    }, [
+        variables
+    ]);
+    const values = useMemo(()=>{
+        const values = {};
+        names === null || names === void 0 ? void 0 : names.forEach((name)=>{
+            const s = states[name];
+            if (s) {
+                values[name] = s;
+            }
+        });
+        return values;
+    }, [
+        names,
+        states
+    ]);
+    if (names === undefined) {
+        return states;
+    }
+    return values;
+}
+export function useBuiltinVariableDefinitions() {
+    const { variables  } = useBuiltinVariableContext();
+    return variables;
+}
+
+//# sourceMappingURL=builtin-variables.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/runtime/builtin-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 { BuiltinVariableDefinition } from '@perses-dev/core';\nimport { VariableStateMap } from './template-variables';\n\nexport type BuiltinVariableSrv = {\n  variables: BuiltinVariableDefinition[];\n};\n\nexport const BuiltinVariableContext = createContext<BuiltinVariableSrv | undefined>(undefined);\n\nexport function useBuiltinVariableContext() {\n  const ctx = useContext(BuiltinVariableContext);\n  if (ctx === undefined) {\n    throw new Error('No BuiltinVariableContext found. Did you forget a Provider?');\n  }\n  return ctx;\n}\n\nexport function useBuiltinVariableValues(names?: string[]): VariableStateMap {\n  const { variables } = useBuiltinVariableContext();\n  const states = useMemo(() => {\n    const values: VariableStateMap = {};\n    for (const variable of variables) {\n      values[variable.spec.name] = { loading: false, value: variable.spec.value() };\n    }\n    return values;\n  }, [variables]);\n\n  const values = useMemo(() => {\n    const values: VariableStateMap = {};\n    names?.forEach((name) => {\n      const s = states[name];\n      if (s) {\n        values[name] = s;\n      }\n    });\n    return values;\n  }, [names, states]);\n\n  if (names === undefined) {\n    return states;\n  }\n\n  return values;\n}\n\nexport function useBuiltinVariableDefinitions(): BuiltinVariableDefinition[] {\n  const { variables } = useBuiltinVariableContext();\n  return variables;\n}\n"],"names":["createContext","useContext","useMemo","BuiltinVariableContext","undefined","useBuiltinVariableContext","ctx","Error","useBuiltinVariableValues","names","variables","states","values","variable","spec","name","loading","value","forEach","s","useBuiltinVariableDefinitions"],"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;AAQ3D,OAAO,MAAMC,yBAAyBH,cAA8CI,WAAW;AAE/F,OAAO,SAASC;IACd,MAAMC,MAAML,WAAWE;IACvB,IAAIG,QAAQF,WAAW;QACrB,MAAM,IAAIG,MAAM;IAClB;IACA,OAAOD;AACT;AAEA,OAAO,SAASE,yBAAyBC,KAAgB;IACvD,MAAM,EAAEC,UAAS,EAAE,GAAGL;IACtB,MAAMM,SAAST,QAAQ;QACrB,MAAMU,SAA2B,CAAC;QAClC,KAAK,MAAMC,YAAYH,UAAW;YAChCE,MAAM,CAACC,SAASC,KAAKC,KAAK,GAAG;gBAAEC,SAAS;gBAAOC,OAAOJ,SAASC,KAAKG;YAAQ;QAC9E;QACA,OAAOL;IACT,GAAG;QAACF;KAAU;IAEd,MAAME,SAASV,QAAQ;QACrB,MAAMU,SAA2B,CAAC;QAClCH,kBAAAA,mBAAAA,KAAAA,IAAAA,MAAOS,QAAQ,CAACH;YACd,MAAMI,IAAIR,MAAM,CAACI,KAAK;YACtB,IAAII,GAAG;gBACLP,MAAM,CAACG,KAAK,GAAGI;YACjB;QACF;QACA,OAAOP;IACT,GAAG;QAACH;QAAOE;KAAO;IAElB,IAAIF,UAAUL,WAAW;QACvB,OAAOO;IACT;IAEA,OAAOC;AACT;AAEA,OAAO,SAASQ;IACd,MAAM,EAAEV,UAAS,EAAE,GAAGL;IACtB,OAAOK;AACT"}

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,0BAAyB,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,oBAA4BF;AACrG;AAEA,OAAO,SAASG,cAAcH,QAA4B;IACxD,MAAMC,QAAQT;IACd,OAAOL,SAAS;QAAC;QAAiBa;KAAS,EAAE,IAAMC,MAAMG,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,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"}