@perses-dev/plugin-system 0.38.0 → 0.40.0

package/dist/cjs/runtime/DataQueriesProvider/DataQueriesProvider.js

@@ -21,18 +21,23 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    useDataQueries: ()=>useDataQueries,
-    DataQueriesContext: ()=>DataQueriesContext,
-    useDataQueriesContext: ()=>useDataQueriesContext,
-    DataQueriesProvider: ()=>DataQueriesProvider
+    DataQueriesContext: function() {
+        return DataQueriesContext;
+    },
+    useDataQueriesContext: function() {
+        return useDataQueriesContext;
+    },
+    useDataQueries: function() {
+        return useDataQueries;
+    },
+    DataQueriesProvider: function() {
+        return DataQueriesProvider;
+    }
 });
-const _jsxRuntime = require("react/jsx-runtime");
+const _jsxruntime = require("react/jsx-runtime");
 const _react = require("react");
-const _timeSeriesQueries = require("../time-series-queries");
-function useDataQueries() {
-    const ctx = useDataQueriesContext();
-    return ctx;
-}
+const _timeseriesqueries = require("../time-series-queries");
+const _model = require("./model");
 const DataQueriesContext = /*#__PURE__*/ (0, _react.createContext)(undefined);
 function useDataQueriesContext() {
     const ctx = (0, _react.useContext)(DataQueriesContext);
@@ -41,47 +46,62 @@ function useDataQueriesContext() {
     }
     return ctx;
 }
+function useDataQueries(queryType) {
+    const ctx = useDataQueriesContext();
+    // Filter the query results based on the specified query type
+    const filteredQueryResults = ctx.queryResults.filter((queryResult)=>queryResult.definition.kind === queryType);
+    // Filter the errors based on the specified query type
+    const filteredErrors = ctx.errors.filter((errors, index)=>{
+        var _ctx_queryResults_index;
+        return ((_ctx_queryResults_index = ctx.queryResults[index]) === null || _ctx_queryResults_index === void 0 ? void 0 : _ctx_queryResults_index.definition.kind) === queryType;
+    });
+    // Create a new context object with the filtered results and errors
+    const filteredCtx = {
+        queryResults: filteredQueryResults,
+        isFetching: filteredQueryResults.some((result)=>result.isFetching),
+        isLoading: filteredQueryResults.some((result)=>result.isLoading),
+        refetchAll: ctx.refetchAll,
+        errors: filteredErrors
+    };
+    return filteredCtx;
+}
 function DataQueriesProvider(props) {
-    const { definitions , options , children  } = props;
-    // For now we will map each query plugin definition to TimeSeriesQueryDefinition
-    // Later on when we add support for other query types,
-    // we will have to map each query maps to the correct QueryDefinition
-    const timeSeriesQueries = definitions.map((definition)=>({
-            kind: 'TimeSeriesQuery',
+    const { definitions , options , children , queryOptions  } = props;
+    const getQueryType = (0, _model.useQueryType)();
+    const queryDefinitions = definitions.map((definition)=>{
+        const type = getQueryType(definition.kind);
+        return {
+            kind: type,
             spec: {
                 plugin: definition
             }
-        }));
-    const results = (0, _timeSeriesQueries.useTimeSeriesQueries)(timeSeriesQueries, options);
-    const data = results.map(({ data , isFetching , isLoading , refetch , error  }, i)=>{
-        return {
-            definition: definitions[i],
-            data,
-            isFetching,
-            isLoading,
-            refetch,
-            error
         };
     });
+    // Filter definitions for time series query and other future query plugins
+    const timeSeriesQueries = queryDefinitions.filter((definition)=>definition.kind === 'TimeSeriesQuery');
+    const timeSeriesResults = (0, _timeseriesqueries.useTimeSeriesQueries)(timeSeriesQueries, options, queryOptions);
     const refetchAll = (0, _react.useCallback)(()=>{
-        results.forEach((result)=>result.refetch());
+        timeSeriesResults.forEach((result)=>result.refetch());
     }, [
-        results
+        timeSeriesResults
     ]);
     const ctx = (0, _react.useMemo)(()=>{
+        const mergedQueryResults = [
+            ...(0, _model.transformQueryResults)(timeSeriesResults, timeSeriesQueries)
+        ];
         return {
-            queryResults: data,
-            isFetching: results.some((result)=>result.isFetching),
-            isLoading: results.some((result)=>result.isLoading),
+            queryResults: mergedQueryResults,
+            isFetching: mergedQueryResults.some((result)=>result.isFetching),
+            isLoading: mergedQueryResults.some((result)=>result.isLoading),
             refetchAll,
-            errors: results.map((result)=>result.error)
+            errors: mergedQueryResults.map((result)=>result.error)
         };
     }, [
-        data,
-        results,
+        timeSeriesQueries,
+        timeSeriesResults,
         refetchAll
     ]);
-    return /*#__PURE__*/ (0, _jsxRuntime.jsx)(DataQueriesContext.Provider, {
+    return /*#__PURE__*/ (0, _jsxruntime.jsx)(DataQueriesContext.Provider, {
         value: ctx,
         children: children
     });

package/dist/cjs/runtime/DataQueriesProvider/index.js

@@ -14,16 +14,18 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_exportStar(require("./DataQueriesProvider"), exports);
-_exportStar(require("./model"), exports);
-function _exportStar(from, to) {
+_export_star(require("./DataQueriesProvider"), exports);
+_export_star(require("./model"), exports);
+function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) Object.defineProperty(to, k, {
-            enumerable: true,
-            get: function() {
-                return from[k];
-            }
-        });
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
     });
     return from;
 }

package/dist/cjs/runtime/DataQueriesProvider/model.js

@@ -14,3 +14,64 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    transformQueryResults: function() {
+        return transformQueryResults;
+    },
+    useQueryType: function() {
+        return useQueryType;
+    }
+});
+const _react = require("react");
+const _pluginregistry = require("../plugin-registry");
+function transformQueryResults(results, definitions) {
+    return results.map(({ data , isFetching , isLoading , refetch , error  }, i)=>{
+        return {
+            definition: definitions[i],
+            data,
+            isFetching,
+            isLoading,
+            refetch,
+            error
+        };
+    });
+}
+function useQueryType() {
+    const { data: timeSeriesQueryPlugins , isLoading  } = (0, _pluginregistry.useListPluginMetadata)('TimeSeriesQuery');
+    const queryTypeMap = (0, _react.useMemo)(()=>{
+        const map = {
+            TimeSeriesQuery: []
+        };
+        if (timeSeriesQueryPlugins) {
+            timeSeriesQueryPlugins.forEach((plugin)=>{
+                var _map_TimeSeriesQuery;
+                (_map_TimeSeriesQuery = map['TimeSeriesQuery']) === null || _map_TimeSeriesQuery === void 0 ? void 0 : _map_TimeSeriesQuery.push(plugin.kind);
+            });
+        }
+        return map;
+    }, [
+        timeSeriesQueryPlugins
+    ]);
+    const getQueryType = (0, _react.useCallback)((pluginKind)=>{
+        if (isLoading) {
+            return undefined;
+        }
+        for(const queryType in queryTypeMap){
+            var _queryTypeMap_queryType;
+            if ((_queryTypeMap_queryType = queryTypeMap[queryType]) === null || _queryTypeMap_queryType === void 0 ? void 0 : _queryTypeMap_queryType.includes(pluginKind)) {
+                return queryType;
+            }
+        }
+        throw new Error(`Unable to determine the query type: ${pluginKind}`);
+    }, [
+        queryTypeMap,
+        isLoading
+    ]);
+    return getQueryType;
+}

package/dist/cjs/runtime/TimeRangeProvider/TimeRangeProvider.js

@@ -21,15 +21,23 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    TimeRangeContext: ()=>TimeRangeContext,
-    useTimeRangeContext: ()=>useTimeRangeContext,
-    useTimeRange: ()=>useTimeRange,
-    TimeRangeProvider: ()=>TimeRangeProvider
+    TimeRangeContext: function() {
+        return TimeRangeContext;
+    },
+    useTimeRangeContext: function() {
+        return useTimeRangeContext;
+    },
+    useTimeRange: function() {
+        return useTimeRange;
+    },
+    TimeRangeProvider: function() {
+        return TimeRangeProvider;
+    }
 });
-const _jsxRuntime = require("react/jsx-runtime");
-const _react = /*#__PURE__*/ _interopRequireWildcard(require("react"));
+const _jsxruntime = require("react/jsx-runtime");
+const _react = /*#__PURE__*/ _interop_require_wildcard(require("react"));
 const _core = require("@perses-dev/core");
-const _queryParams = require("./query-params");
+const _queryparams = require("./query-params");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -38,7 +46,7 @@ function _getRequireWildcardCache(nodeInterop) {
         return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
     })(nodeInterop);
 }
-function _interopRequireWildcard(obj, nodeInterop) {
+function _interop_require_wildcard(obj, nodeInterop) {
     if (!nodeInterop && obj && obj.__esModule) {
         return obj;
     }
@@ -82,8 +90,8 @@ function useTimeRange() {
 }
 function TimeRangeProvider(props) {
     const { initialTimeRange , initialRefreshInterval , enabledURLParams , children  } = props;
-    const { timeRange , setTimeRange  } = (0, _queryParams.useSetTimeRangeParams)(initialTimeRange, enabledURLParams);
-    const { refreshInterval , setRefreshInterval , refreshIntervalInMs  } = (0, _queryParams.useSetRefreshIntervalParams)(initialRefreshInterval, enabledURLParams);
+    const { timeRange , setTimeRange  } = (0, _queryparams.useSetTimeRangeParams)(initialTimeRange, enabledURLParams);
+    const { refreshInterval , setRefreshInterval , refreshIntervalInMs  } = (0, _queryparams.useSetRefreshIntervalParams)(initialRefreshInterval, enabledURLParams);
     const [refreshKey, setRefreshKey] = (0, _react.useState)(0);
     const refresh = (0, _react.useCallback)(()=>{
         setRefreshKey(refreshKey + 1);
@@ -111,7 +119,7 @@ function TimeRangeProvider(props) {
         refreshIntervalInMs,
         setRefreshInterval
     ]);
-    return /*#__PURE__*/ (0, _jsxRuntime.jsx)(TimeRangeContext.Provider, {
+    return /*#__PURE__*/ (0, _jsxruntime.jsx)(TimeRangeContext.Provider, {
         value: ctx,
         children: children
     });

package/dist/cjs/runtime/TimeRangeProvider/index.js

@@ -14,16 +14,18 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_exportStar(require("./TimeRangeProvider"), exports);
-_exportStar(require("./query-params"), exports);
-function _exportStar(from, to) {
+_export_star(require("./TimeRangeProvider"), exports);
+_export_star(require("./query-params"), exports);
+function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) Object.defineProperty(to, k, {
-            enumerable: true,
-            get: function() {
-                return from[k];
-            }
-        });
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
     });
     return from;
 }

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

@@ -21,19 +21,37 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    encodeTimeRangeValue: ()=>encodeTimeRangeValue,
-    decodeTimeRangeValue: ()=>decodeTimeRangeValue,
-    TimeRangeParam: ()=>TimeRangeParam,
-    timeRangeQueryConfig: ()=>timeRangeQueryConfig,
-    refreshIntervalQueryConfig: ()=>refreshIntervalQueryConfig,
-    useInitialTimeRange: ()=>useInitialTimeRange,
-    useSetTimeRangeParams: ()=>useSetTimeRangeParams,
-    useInitialRefreshInterval: ()=>useInitialRefreshInterval,
-    useSetRefreshIntervalParams: ()=>useSetRefreshIntervalParams
+    encodeTimeRangeValue: function() {
+        return encodeTimeRangeValue;
+    },
+    decodeTimeRangeValue: function() {
+        return decodeTimeRangeValue;
+    },
+    TimeRangeParam: function() {
+        return TimeRangeParam;
+    },
+    timeRangeQueryConfig: function() {
+        return timeRangeQueryConfig;
+    },
+    refreshIntervalQueryConfig: function() {
+        return refreshIntervalQueryConfig;
+    },
+    useInitialTimeRange: function() {
+        return useInitialTimeRange;
+    },
+    useSetTimeRangeParams: function() {
+        return useSetTimeRangeParams;
+    },
+    useInitialRefreshInterval: function() {
+        return useInitialRefreshInterval;
+    },
+    useSetRefreshIntervalParams: function() {
+        return useSetRefreshIntervalParams;
+    }
 });
 const _react = require("react");
-const _useQueryParams = require("use-query-params");
-const _dateFns = require("date-fns");
+const _usequeryparams = require("use-query-params");
+const _datefns = require("date-fns");
 const _core = require("@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) {
@@ -61,7 +79,7 @@ function encodeTimeRangeValue(timeOptionValue) {
             return timeOptionValue;
         }
     }
-    return ((0, _dateFns.getUnixTime)(timeOptionValue) * 1000).toString();
+    return ((0, _datefns.getUnixTime)(timeOptionValue) * 1000).toString();
 }
 function decodeTimeRangeValue(input) {
     const paramString = getEncodedValue(input);
@@ -85,7 +103,7 @@ const refreshIntervalQueryConfig = {
     refresh: TimeRangeParam
 };
 function useInitialTimeRange(dashboardDuration) {
-    const [query] = (0, _useQueryParams.useQueryParams)(timeRangeQueryConfig, {
+    const [query] = (0, _usequeryparams.useQueryParams)(timeRangeQueryConfig, {
         updateType: 'replaceIn'
     });
     const { start , end  } = query;
@@ -101,7 +119,7 @@ function useInitialTimeRange(dashboardDuration) {
             initialTimeRange = {
                 pastDuration: startStr
             };
-        } else if ((0, _dateFns.isDate)(start) && (0, _dateFns.isDate)(end)) {
+        } else if ((0, _datefns.isDate)(start) && (0, _datefns.isDate)(end)) {
             initialTimeRange = {
                 start: start,
                 end: end
@@ -115,7 +133,7 @@ function useInitialTimeRange(dashboardDuration) {
     ]);
 }
 function useSetTimeRangeParams(initialTimeRange, enabledURLParams = true) {
-    const [query, setQuery] = (0, _useQueryParams.useQueryParams)(timeRangeQueryConfig, {
+    const [query, setQuery] = (0, _usequeryparams.useQueryParams)(timeRangeQueryConfig, {
         updateType: 'replaceIn'
     });
     // determine whether initial param had previously been populated to fix back btn
@@ -166,7 +184,7 @@ function useSetTimeRangeParams(initialTimeRange, enabledURLParams = true) {
     };
 }
 function useInitialRefreshInterval(dashboardDuration) {
-    const [query] = (0, _useQueryParams.useQueryParams)(refreshIntervalQueryConfig, {
+    const [query] = (0, _usequeryparams.useQueryParams)(refreshIntervalQueryConfig, {
         updateType: 'replaceIn'
     });
     const { refresh  } = query;
@@ -196,7 +214,7 @@ function getRefreshIntervalInMs(refreshInterval) {
     return refreshIntervalInMs;
 }
 function useSetRefreshIntervalParams(initialRefreshInterval, enabledURLParams = true) {
-    const [query, setQuery] = (0, _useQueryParams.useQueryParams)(refreshIntervalQueryConfig, {
+    const [query, setQuery] = (0, _usequeryparams.useQueryParams)(refreshIntervalQueryConfig, {
         updateType: 'replaceIn'
     });
     // determine whether initial param had previously been populated to fix back btn
@@ -206,7 +224,7 @@ function useSetRefreshIntervalParams(initialRefreshInterval, enabledURLParams =
     const [refreshIntervalState, setRefreshIntervalState] = (0, _react.useState)(initialRefreshInterval);
     const { refresh  } = query;
     (0, _react.useEffect)(()=>{
-        // when dashboard loaded with no params, default to dashboard duration
+        // when dashboard loaded with no params, default to dashboard refresh interval
         if (enabledURLParams && !paramsLoaded && !refresh) {
             setQuery({
                 refresh: initialRefreshInterval

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

@@ -0,0 +1,81 @@
+// Copyright 2023 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    BuiltinVariableContext: function() {
+        return BuiltinVariableContext;
+    },
+    useBuiltinVariableContext: function() {
+        return useBuiltinVariableContext;
+    },
+    useBuiltinVariableValues: function() {
+        return useBuiltinVariableValues;
+    },
+    useBuiltinVariableDefinitions: function() {
+        return useBuiltinVariableDefinitions;
+    }
+});
+const _react = require("react");
+const BuiltinVariableContext = (0, _react.createContext)(undefined);
+function useBuiltinVariableContext() {
+    const ctx = (0, _react.useContext)(BuiltinVariableContext);
+    if (ctx === undefined) {
+        throw new Error('No BuiltinVariableContext found. Did you forget a Provider?');
+    }
+    return ctx;
+}
+function useBuiltinVariableValues(names) {
+    const { variables  } = useBuiltinVariableContext();
+    const states = (0, _react.useMemo)(()=>{
+        const values = {};
+        for (const variable of variables){
+            values[variable.spec.name] = {
+                loading: false,
+                value: variable.spec.value()
+            };
+        }
+        return values;
+    }, [
+        variables
+    ]);
+    const values = (0, _react.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;
+}
+function useBuiltinVariableDefinitions() {
+    const { variables  } = useBuiltinVariableContext();
+    return variables;
+}

package/dist/cjs/runtime/datasources.js

@@ -21,12 +21,23 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    DatasourceStoreContext: ()=>DatasourceStoreContext,
-    useDatasourceStore: ()=>useDatasourceStore,
-    useListDatasources: ()=>useListDatasources,
-    useDatasourceClient: ()=>useDatasourceClient
+    DatasourceStoreContext: function() {
+        return DatasourceStoreContext;
+    },
+    useDatasourceStore: function() {
+        return useDatasourceStore;
+    },
+    useListDatasourceSelectItems: function() {
+        return useListDatasourceSelectItems;
+    },
+    useDatasourceClient: function() {
+        return useDatasourceClient;
+    },
+    useDatasource: function() {
+        return useDatasource;
+    }
 });
-const _reactQuery = require("@tanstack/react-query");
+const _reactquery = require("@tanstack/react-query");
 const _react = require("react");
 const DatasourceStoreContext = (0, _react.createContext)(undefined);
 function useDatasourceStore() {
@@ -36,17 +47,24 @@ function useDatasourceStore() {
     }
     return ctx;
 }
-function useListDatasources(datasourcePluginKind) {
-    const { listDatasourceMetadata  } = useDatasourceStore();
-    return (0, _reactQuery.useQuery)([
-        'listDatasourceMetadata',
+function useListDatasourceSelectItems(datasourcePluginKind) {
+    const { listDatasourceSelectItems  } = useDatasourceStore();
+    return (0, _reactquery.useQuery)([
+        'listDatasourceSelectItems',
         datasourcePluginKind
-    ], ()=>listDatasourceMetadata(datasourcePluginKind));
+    ], ()=>listDatasourceSelectItems(datasourcePluginKind));
 }
 function useDatasourceClient(selector) {
     const store = useDatasourceStore();
-    return (0, _reactQuery.useQuery)([
+    return (0, _reactquery.useQuery)([
         'getDatasourceClient',
         selector
     ], ()=>store.getDatasourceClient(selector));
 }
+function useDatasource(selector) {
+    const store = useDatasourceStore();
+    return (0, _reactquery.useQuery)([
+        'getDatasource',
+        selector
+    ], ()=>store.getDatasource(selector));
+}

package/dist/cjs/runtime/index.js

@@ -14,20 +14,23 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_exportStar(require("./datasources"), exports);
-_exportStar(require("./plugin-registry"), exports);
-_exportStar(require("./template-variables"), exports);
-_exportStar(require("./TimeRangeProvider"), exports);
-_exportStar(require("./time-series-queries"), exports);
-_exportStar(require("./DataQueriesProvider"), exports);
-function _exportStar(from, to) {
+_export_star(require("./builtin-variables"), exports);
+_export_star(require("./datasources"), exports);
+_export_star(require("./plugin-registry"), exports);
+_export_star(require("./template-variables"), exports);
+_export_star(require("./TimeRangeProvider"), exports);
+_export_star(require("./time-series-queries"), exports);
+_export_star(require("./DataQueriesProvider"), exports);
+function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) Object.defineProperty(to, k, {
-            enumerable: true,
-            get: function() {
-                return from[k];
-            }
-        });
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
     });
     return from;
 }