@perses-dev/dashboards 0.0.0-snapshot-scatterplot-fix-imports-95e1b59 → 0.0.0-snapshot-explorer-plugin-c4a7621

package/dist/context/DatasourceStoreProvider.d.ts

@@ -1,5 +1,5 @@
-import { ReactNode } from 'react';
-import { DashboardResource, ProjectDatasource, DatasourceSelector, DatasourceSpec, GlobalDatasource, EphemeralDashboardResource } from '@perses-dev/core';
+import { ReactElement, ReactNode } from 'react';
+import { DashboardResource, DatasourceResource, DatasourceSelector, DatasourceSpec, GlobalDatasourceResource, EphemeralDashboardResource } from '@perses-dev/core';
 import { DatasourceClient } from '@perses-dev/plugin-system';
 export interface DatasourceStoreProviderProps {
     dashboardResource?: DashboardResource | EphemeralDashboardResource;
@@ -20,13 +20,13 @@ export type BuildDatasourceProxyUrlFunc = (p: BuildDatasourceProxyUrlParams) =>
  */
 export interface DatasourceApi {
     buildProxyUrl?: BuildDatasourceProxyUrlFunc;
-    getDatasource: (project: string, selector: DatasourceSelector) => Promise<ProjectDatasource | undefined>;
-    getGlobalDatasource: (selector: DatasourceSelector) => Promise<GlobalDatasource | undefined>;
-    listDatasources: (project: string, pluginKind?: string) => Promise<ProjectDatasource[]>;
-    listGlobalDatasources: (pluginKind?: string) => Promise<GlobalDatasource[]>;
+    getDatasource: (project: string, selector: DatasourceSelector) => Promise<DatasourceResource | undefined>;
+    getGlobalDatasource: (selector: DatasourceSelector) => Promise<GlobalDatasourceResource | undefined>;
+    listDatasources: (project: string, pluginKind?: string) => Promise<DatasourceResource[]>;
+    listGlobalDatasources: (pluginKind?: string) => Promise<GlobalDatasourceResource[]>;
 }
 /**
  * A `DatasourceContext` provider that uses an external API to resolve datasource selectors.
  */
-export declare function DatasourceStoreProvider(props: DatasourceStoreProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function DatasourceStoreProvider(props: DatasourceStoreProviderProps): ReactElement;
 //# sourceMappingURL=DatasourceStoreProvider.d.ts.map

package/dist/context/DatasourceStoreProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DatasourceStoreProvider.d.ts","sourceRoot":"","sources":["../../src/context/DatasourceStoreProvider.tsx"],"names":[],"mappings":"AAaA,OAAO,EAAE,SAAS,EAAkC,MAAM,OAAO,CAAC;AAClE,OAAO,EACL,iBAAiB,EAEjB,iBAAiB,EACjB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAEhB,0BAA0B,EAE3B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAKL,gBAAgB,EAEjB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,WAAW,4BAA4B;IAC3C,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,0BAA0B,CAAC;IACnE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAClD,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,gBAAgB,CAAC;CAC3D;AAED,MAAM,MAAM,6BAA6B,GAAG;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,EAAE,6BAA6B,KAAK,MAAM,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,aAAa,CAAC,EAAE,2BAA2B,CAAC;IAE5C,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,KAAK,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IAEzG,mBAAmB,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAC;IAE7F,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAExF,qBAAqB,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;CAC7E;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,4BAA4B,2CAyL1E"}
+{"version":3,"file":"DatasourceStoreProvider.d.ts","sourceRoot":"","sources":["../../src/context/DatasourceStoreProvider.tsx"],"names":[],"mappings":"AAaA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAkC,MAAM,OAAO,CAAC;AAChF,OAAO,EACL,iBAAiB,EAEjB,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,wBAAwB,EAExB,0BAA0B,EAE3B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAKL,gBAAgB,EAEjB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,WAAW,4BAA4B;IAC3C,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,0BAA0B,CAAC;IACnE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAClD,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,gBAAgB,CAAC;CAC3D;AAED,MAAM,MAAM,6BAA6B,GAAG;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,EAAE,6BAA6B,KAAK,MAAM,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,aAAa,CAAC,EAAE,2BAA2B,CAAC;IAC5C,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,KAAK,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;IAC1G,mBAAmB,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC,CAAC;IACrG,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACzF,qBAAqB,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC;CACrF;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,4BAA4B,GAAG,YAAY,CAyLzF"}

package/dist/context/DatasourceStoreProvider.js

@@ -19,9 +19,8 @@ import { DatasourceStoreContext, usePluginRegistry } from '@perses-dev/plugin-sy
  */ export function DatasourceStoreProvider(props) {
     const { projectName, datasourceApi, onCreate, children } = props;
     const [dashboardResource, setDashboardResource] = useState(props.dashboardResource);
-    var _props_savedDatasources;
-    const [savedDatasources, setSavedDatasources] = useState((_props_savedDatasources = props.savedDatasources) !== null && _props_savedDatasources !== void 0 ? _props_savedDatasources : {});
-    const project = projectName !== null && projectName !== void 0 ? projectName : dashboardResource === null || dashboardResource === void 0 ? void 0 : dashboardResource.metadata.project;
+    const [savedDatasources, setSavedDatasources] = useState(props.savedDatasources ?? {});
+    const project = projectName ?? dashboardResource?.metadata.project;
     const { getPlugin, listPluginMetadata } = usePluginRegistry();
     const findDatasource = useEvent(async (selector)=>{
         // Try to find it in dashboard spec
@@ -91,24 +90,26 @@ import { DatasourceStoreContext, usePluginRegistry } from '@perses-dev/plugin-sy
         getPlugin,
         onCreate
     ]);
-    const listDatasourceSelectItems = useEvent(async (datasourcePluginKind)=>{
+    const listDatasourceSelectItems = useEvent(async (datasourcePluginName)=>{
         const [pluginMetadata, datasources, globalDatasources] = await Promise.all([
-            listPluginMetadata('Datasource'),
-            project ? datasourceApi.listDatasources(project, datasourcePluginKind) : [],
-            datasourceApi.listGlobalDatasources(datasourcePluginKind)
+            listPluginMetadata([
+                'Datasource'
+            ]),
+            project ? datasourceApi.listDatasources(project, datasourcePluginName) : [],
+            datasourceApi.listGlobalDatasources(datasourcePluginName)
         ]);
         // Find the metadata for the plugin type they asked for, so we can use it for the name of the default datasource
-        const datasourcePluginMetadata = pluginMetadata.find((metadata)=>metadata.kind === datasourcePluginKind);
+        const datasourcePluginMetadata = pluginMetadata.find((metadata)=>metadata.spec.name === datasourcePluginName);
         if (datasourcePluginMetadata === undefined) {
-            throw new Error(`Could not find a Datasource plugin with kind '${datasourcePluginKind}'`);
+            throw new Error(`Could not find a Datasource plugin with kind '${datasourcePluginName}'`);
         }
         // Get helper for computing results properly
-        const { results, addItem } = buildDatasourceSelectItemGroups(datasourcePluginMetadata.display.name);
+        const { results, addItem } = buildDatasourceSelectItemGroups(datasourcePluginMetadata.spec.display.name);
         // Start with dashboard datasources with the highest precedence
-        if (dashboardResource === null || dashboardResource === void 0 ? void 0 : dashboardResource.spec.datasources) {
+        if (dashboardResource?.spec.datasources) {
             for(const selectorName in dashboardResource.spec.datasources){
                 const spec = dashboardResource.spec.datasources[selectorName];
-                if (spec === undefined || spec.plugin.kind !== datasourcePluginKind) continue;
+                if (spec === undefined || spec.plugin.kind !== datasourcePluginName) continue;
                 const saved = selectorName in savedDatasources;
                 addItem({
                     spec,
@@ -141,8 +142,7 @@ import { DatasourceStoreContext, usePluginRegistry } from '@perses-dev/plugin-sy
         return results;
     });
     const getLocalDatasources = useCallback(()=>{
-        var _dashboardResource_spec_datasources;
-        return (_dashboardResource_spec_datasources = dashboardResource === null || dashboardResource === void 0 ? void 0 : dashboardResource.spec.datasources) !== null && _dashboardResource_spec_datasources !== void 0 ? _dashboardResource_spec_datasources : {};
+        return dashboardResource?.spec.datasources ?? {};
     }, [
         dashboardResource
     ]);
@@ -228,8 +228,7 @@ function findDashboardDatasource(dashboardDatasources, selector) {
     const groupIndices = {};
     let currentGroupIndex = 1; // 0 is the default group, always there as it contains at least the first item.
     const addItem = ({ spec, selectorName, selectorGroup: group, editLink, saved })=>{
-        var _spec_display;
-        group = group !== null && group !== void 0 ? group : '';
+        group = group ?? '';
         // Ensure the default group is always present as soon as an item is added.
         if (isFirst) {
             results.push({
@@ -237,9 +236,8 @@ function findDashboardDatasource(dashboardDatasources, selector) {
                 items: []
             });
         }
-        var _groupIndices_group;
         // Create the group if necessary
-        let selectItemGroup = results[(_groupIndices_group = groupIndices[group]) !== null && _groupIndices_group !== void 0 ? _groupIndices_group : -1];
+        let selectItemGroup = results[groupIndices[group] ?? -1];
         if (!selectItemGroup) {
             groupIndices[group] = currentGroupIndex;
             selectItemGroup = {
@@ -252,9 +250,8 @@ function findDashboardDatasource(dashboardDatasources, selector) {
         }
         // Add item to the group
         const isOverridden = usedNames.has(selectorName);
-        var _spec_display_name;
         selectItemGroup.items.push({
-            name: (_spec_display_name = (_spec_display = spec.display) === null || _spec_display === void 0 ? void 0 : _spec_display.name) !== null && _spec_display_name !== void 0 ? _spec_display_name : selectorName,
+            name: spec.display?.name ?? selectorName,
             overridden: isOverridden,
             saved,
             selector: {
@@ -283,9 +280,7 @@ function findDashboardDatasource(dashboardDatasources, selector) {
         // At the end, we make sure the overriding item(s) is well flagged so
         if (isOverridden) {
             for(let i = explicitDefaultAdded ? 1 : 0; i < currentGroupIndex; i++){
-                var _results_i;
-                var _results_i_items;
-                ((_results_i_items = (_results_i = results[i]) === null || _results_i === void 0 ? void 0 : _results_i.items) !== null && _results_i_items !== void 0 ? _results_i_items : []).filter((item)=>item.selector.name === selectorName).forEach((item)=>{
+                (results[i]?.items ?? []).filter((item)=>item.selector.name === selectorName).forEach((item)=>{
                     item.overriding = true;
                 });
             }

package/dist/context/DatasourceStoreProvider.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/context/DatasourceStoreProvider.tsx"],"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 { ReactNode, useCallback, useMemo, useState } from 'react';\nimport {\n  DashboardResource,\n  DashboardSpec,\n  ProjectDatasource,\n  DatasourceSelector,\n  DatasourceSpec,\n  GlobalDatasource,\n  useEvent,\n  EphemeralDashboardResource,\n  DatasourceDefinition,\n} from '@perses-dev/core';\nimport {\n  DatasourceStoreContext,\n  DatasourceStore,\n  DatasourceSelectItemGroup,\n  usePluginRegistry,\n  DatasourceClient,\n  DatasourceSelectItem,\n} from '@perses-dev/plugin-system';\n\nexport interface DatasourceStoreProviderProps {\n  dashboardResource?: DashboardResource | EphemeralDashboardResource;\n  projectName?: string;\n  datasourceApi: DatasourceApi;\n  children?: ReactNode;\n  savedDatasources?: Record<string, DatasourceSpec>;\n  onCreate?: (client: DatasourceClient) => DatasourceClient;\n}\n\nexport type BuildDatasourceProxyUrlParams = {\n  project?: string;\n  dashboard?: string;\n  name: string;\n};\n\nexport type BuildDatasourceProxyUrlFunc = (p: BuildDatasourceProxyUrlParams) => string;\n\n/**\n * The external API for fetching datasource resources\n */\nexport interface DatasourceApi {\n  buildProxyUrl?: BuildDatasourceProxyUrlFunc;\n\n  getDatasource: (project: string, selector: DatasourceSelector) => Promise<ProjectDatasource | undefined>;\n\n  getGlobalDatasource: (selector: DatasourceSelector) => Promise<GlobalDatasource | undefined>;\n\n  listDatasources: (project: string, pluginKind?: string) => Promise<ProjectDatasource[]>;\n\n  listGlobalDatasources: (pluginKind?: string) => Promise<GlobalDatasource[]>;\n}\n\n/**\n * A `DatasourceContext` provider that uses an external API to resolve datasource selectors.\n */\nexport function DatasourceStoreProvider(props: DatasourceStoreProviderProps) {\n  const { projectName, datasourceApi, onCreate, children } = props;\n  const [dashboardResource, setDashboardResource] = useState(props.dashboardResource);\n  const [savedDatasources, setSavedDatasources] = useState<Record<string, DatasourceSpec>>(\n    props.savedDatasources ?? {}\n  );\n  const project = projectName ?? dashboardResource?.metadata.project;\n\n  const { getPlugin, listPluginMetadata } = usePluginRegistry();\n\n  const findDatasource = useEvent(async (selector: DatasourceSelector) => {\n    // Try to find it in dashboard spec\n    if (dashboardResource) {\n      const { datasources } = dashboardResource.spec;\n      const dashboardDatasource = findDashboardDatasource(datasources, selector);\n      if (dashboardDatasource !== undefined) {\n        return {\n          spec: dashboardDatasource.spec,\n          proxyUrl: buildDatasourceProxyUrl(datasourceApi, {\n            project: dashboardResource.metadata.project,\n            dashboard: dashboardResource.metadata.name,\n            name: dashboardDatasource.name,\n          }),\n        };\n      }\n    }\n\n    if (project) {\n      // Try to find it at the project level as a Datasource resource\n      const datasource = await datasourceApi.getDatasource(project, selector);\n      if (datasource !== undefined) {\n        return {\n          spec: datasource.spec,\n          proxyUrl: buildDatasourceProxyUrl(datasourceApi, {\n            project: datasource.metadata.project,\n            name: datasource.metadata.name,\n          }),\n        };\n      }\n    }\n\n    // Try to find it at the global level as a GlobalDatasource resource\n    const globalDatasource = await datasourceApi.getGlobalDatasource(selector);\n    if (globalDatasource !== undefined) {\n      return {\n        spec: globalDatasource.spec,\n        proxyUrl: buildDatasourceProxyUrl(datasourceApi, {\n          name: globalDatasource.metadata.name,\n        }),\n      };\n    }\n\n    throw new Error(`No datasource found for kind '${selector.kind}' and name '${selector.name}'`);\n  });\n\n  // Gets a datasource spec for a given selector\n  const getDatasource = useCallback(\n    async (selector: DatasourceSelector): Promise<DatasourceSpec> => {\n      const { spec } = await findDatasource(selector);\n      return spec;\n    },\n    [findDatasource]\n  );\n\n  // Given a Datasource selector, finds the spec for it and then uses its corresponding plugin the create a client\n  const getDatasourceClient = useCallback(\n    async function getClient<Client extends DatasourceClient>(selector: DatasourceSelector): Promise<Client> {\n      const { kind } = selector;\n      const [{ spec, proxyUrl }, plugin] = await Promise.all([findDatasource(selector), getPlugin('Datasource', kind)]);\n\n      // allows extending client\n      const client = plugin.createClient(spec.plugin.spec, { proxyUrl }) as Client;\n      if (onCreate !== undefined) {\n        return onCreate(client) as Client;\n      }\n      return client;\n    },\n    [findDatasource, getPlugin, onCreate]\n  );\n\n  const listDatasourceSelectItems = useEvent(\n    async (datasourcePluginKind: string): Promise<DatasourceSelectItemGroup[]> => {\n      const [pluginMetadata, datasources, globalDatasources] = await Promise.all([\n        listPluginMetadata('Datasource'),\n        project ? datasourceApi.listDatasources(project, datasourcePluginKind) : [],\n        datasourceApi.listGlobalDatasources(datasourcePluginKind),\n      ]);\n\n      // Find the metadata for the plugin type they asked for, so we can use it for the name of the default datasource\n      const datasourcePluginMetadata = pluginMetadata.find((metadata) => metadata.kind === datasourcePluginKind);\n      if (datasourcePluginMetadata === undefined) {\n        throw new Error(`Could not find a Datasource plugin with kind '${datasourcePluginKind}'`);\n      }\n\n      // Get helper for computing results properly\n      const { results, addItem } = buildDatasourceSelectItemGroups(datasourcePluginMetadata.display.name);\n\n      // Start with dashboard datasources with the highest precedence\n      if (dashboardResource?.spec.datasources) {\n        for (const selectorName in dashboardResource.spec.datasources) {\n          const spec = dashboardResource.spec.datasources[selectorName];\n          if (spec === undefined || spec.plugin.kind !== datasourcePluginKind) continue;\n\n          const saved = selectorName in savedDatasources;\n          addItem({ spec, selectorName, selectorGroup: 'dashboard', saved });\n        }\n      }\n\n      // Now look at project-level datasources\n      for (const datasource of datasources) {\n        const selectorName = datasource.metadata.name;\n        addItem({\n          spec: datasource.spec,\n          selectorName,\n          selectorGroup: 'project',\n          editLink: `/projects/${project}/datasources`,\n        });\n      }\n\n      // And finally global datasources\n      for (const globalDatasource of globalDatasources) {\n        const selectorName = globalDatasource.metadata.name;\n        addItem({ spec: globalDatasource.spec, selectorName, selectorGroup: 'global', editLink: '/admin/datasources' });\n      }\n\n      return results;\n    }\n  );\n\n  const getLocalDatasources = useCallback((): Record<string, DatasourceSpec> => {\n    return dashboardResource?.spec.datasources ?? {};\n  }, [dashboardResource]);\n\n  const getSavedDatasources = useCallback((): Record<string, DatasourceSpec> => {\n    return savedDatasources;\n  }, [savedDatasources]);\n\n  const setLocalDatasources = useCallback(\n    (datasources: Record<string, DatasourceSpec>) => {\n      if (dashboardResource) {\n        setDashboardResource(\n          dashboardResource.kind === 'Dashboard'\n            ? ({\n                ...dashboardResource,\n                spec: {\n                  ...dashboardResource.spec,\n                  datasources: datasources,\n                },\n              } as DashboardResource)\n            : ({\n                ...dashboardResource,\n                spec: {\n                  ...dashboardResource.spec,\n                  datasources: datasources,\n                },\n              } as EphemeralDashboardResource)\n        );\n      }\n    },\n    [dashboardResource]\n  );\n\n  const ctxValue: DatasourceStore = useMemo(\n    () =>\n      ({\n        getDatasource,\n        getDatasourceClient,\n        getLocalDatasources,\n        setLocalDatasources,\n        setSavedDatasources,\n        getSavedDatasources,\n        listDatasourceSelectItems,\n      }) as DatasourceStore,\n    [\n      getDatasource,\n      getDatasourceClient,\n      getLocalDatasources,\n      setLocalDatasources,\n      listDatasourceSelectItems,\n      setSavedDatasources,\n      getSavedDatasources,\n    ]\n  );\n\n  return <DatasourceStoreContext.Provider value={ctxValue}>{children}</DatasourceStoreContext.Provider>;\n}\n\nfunction buildDatasourceProxyUrl(api: DatasourceApi, params: BuildDatasourceProxyUrlParams): string {\n  return api.buildProxyUrl ? api.buildProxyUrl(params) : '';\n}\n\n// Helper to find a datasource in the list embedded in a dashboard spec\nfunction findDashboardDatasource(\n  dashboardDatasources: DashboardSpec['datasources'],\n  selector: DatasourceSelector\n): DatasourceDefinition | undefined {\n  if (dashboardDatasources === undefined) return undefined;\n\n  // If using a name in the selector...\n  if (selector.name !== undefined) {\n    const named = dashboardDatasources[selector.name];\n    if (named === undefined) return undefined;\n    return named.plugin.kind === selector.kind ? { name: selector.name, spec: named } : undefined;\n  }\n\n  // If only using a kind, try to find one with that kind that is the default\n  const result = Object.entries(dashboardDatasources).find(\n    (entry) => entry[1].plugin.kind === selector.kind && entry[1].default\n  );\n  if (!result) {\n    return undefined;\n  }\n  return { name: result[0], spec: result[1] };\n}\n\ninterface AddDatasouceSelectItemParams {\n  spec: DatasourceSpec;\n  selectorName: string;\n  selectorGroup?: string;\n  editLink?: string;\n  saved?: boolean;\n}\n\ntype AddDatasourceSelectItemFunc = (params: AddDatasouceSelectItemParams) => void;\n\n/**\n * Helper for building a list of DatasourceSelectItemGroup results.\n * @param pluginDisplayName\n */\nfunction buildDatasourceSelectItemGroups(pluginDisplayName: string): {\n  results: DatasourceSelectItemGroup[];\n  addItem: AddDatasourceSelectItemFunc;\n} {\n  const results: DatasourceSelectItemGroup[] = [];\n  const usedNames = new Set<string>();\n  let isFirst = true;\n  let explicitDefaultAdded = false;\n  const groupIndices: Record<string, number> = {};\n  let currentGroupIndex = 1; // 0 is the default group, always there as it contains at least the first item.\n\n  const addItem = ({ spec, selectorName, selectorGroup: group, editLink, saved }: AddDatasouceSelectItemParams) => {\n    group = group ?? '';\n\n    // Ensure the default group is always present as soon as an item is added.\n    if (isFirst) {\n      results.push({\n        group: `Default ${pluginDisplayName}`,\n        items: [],\n      });\n    }\n\n    // Create the group if necessary\n    let selectItemGroup = results[groupIndices[group] ?? -1];\n    if (!selectItemGroup) {\n      groupIndices[group] = currentGroupIndex;\n      selectItemGroup = { items: [], group, editLink };\n      results[currentGroupIndex] = selectItemGroup;\n      currentGroupIndex++;\n    }\n\n    // Add item to the group\n    const isOverridden = usedNames.has(selectorName);\n    selectItemGroup.items.push({\n      name: spec.display?.name ?? selectorName,\n      overridden: isOverridden,\n      saved,\n      selector: {\n        kind: spec.plugin.kind,\n        name: selectorName,\n        group,\n      },\n    });\n    usedNames.add(selectorName);\n\n    const isExplicitDefault = !isOverridden && spec.default && !explicitDefaultAdded;\n    if (results[0] && (isFirst || isExplicitDefault)) {\n      // If we haven't added a default yet and this is a default, add default option to the beginning of the results\n      results[0].items = [\n        {\n          name: `Default (${selectorName} from ${group})`,\n          selector: {\n            kind: spec.plugin.kind,\n          },\n        },\n      ];\n      // We consider that we added the default datasource only if it has been explicitly set as default.\n      // If we add this datasource as default just because it's the first, it still needs to be overridable by\n      // another datasource explicitly set as default.\n      explicitDefaultAdded = isExplicitDefault;\n    }\n\n    // At the end, we make sure the overriding item(s) is well flagged so\n    if (isOverridden) {\n      for (let i = explicitDefaultAdded ? 1 : 0; i < currentGroupIndex; i++) {\n        (results[i]?.items ?? [])\n          .filter((item: DatasourceSelectItem) => item.selector.name === selectorName)\n          .forEach((item: DatasourceSelectItem) => {\n            item.overriding = true;\n          });\n      }\n    }\n\n    isFirst = false;\n  };\n\n  return { results, addItem };\n}\n"],"names":["useCallback","useMemo","useState","useEvent","DatasourceStoreContext","usePluginRegistry","DatasourceStoreProvider","props","projectName","datasourceApi","onCreate","children","dashboardResource","setDashboardResource","savedDatasources","setSavedDatasources","project","metadata","getPlugin","listPluginMetadata","findDatasource","selector","datasources","spec","dashboardDatasource","findDashboardDatasource","undefined","proxyUrl","buildDatasourceProxyUrl","dashboard","name","datasource","getDatasource","globalDatasource","getGlobalDatasource","Error","kind","getDatasourceClient","getClient","plugin","Promise","all","client","createClient","listDatasourceSelectItems","datasourcePluginKind","pluginMetadata","globalDatasources","listDatasources","listGlobalDatasources","datasourcePluginMetadata","find","results","addItem","buildDatasourceSelectItemGroups","display","selectorName","saved","selectorGroup","editLink","getLocalDatasources","getSavedDatasources","setLocalDatasources","ctxValue","Provider","value","api","params","buildProxyUrl","dashboardDatasources","named","result","Object","entries","entry","default","pluginDisplayName","usedNames","Set","isFirst","explicitDefaultAdded","groupIndices","currentGroupIndex","group","push","items","selectItemGroup","isOverridden","has","overridden","add","isExplicitDefault","i","filter","item","forEach","overriding"],"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,SAAoBA,WAAW,EAAEC,OAAO,EAAEC,QAAQ,QAAQ,QAAQ;AAClE,SAOEC,QAAQ,QAGH,mBAAmB;AAC1B,SACEC,sBAAsB,EAGtBC,iBAAiB,QAGZ,4BAA4B;AAkCnC;;CAEC,GACD,OAAO,SAASC,wBAAwBC,KAAmC;IACzE,MAAM,EAAEC,WAAW,EAAEC,aAAa,EAAEC,QAAQ,EAAEC,QAAQ,EAAE,GAAGJ;IAC3D,MAAM,CAACK,mBAAmBC,qBAAqB,GAAGX,SAASK,MAAMK,iBAAiB;QAEhFL;IADF,MAAM,CAACO,kBAAkBC,oBAAoB,GAAGb,SAC9CK,CAAAA,0BAAAA,MAAMO,gBAAgB,cAAtBP,qCAAAA,0BAA0B,CAAC;IAE7B,MAAMS,UAAUR,wBAAAA,yBAAAA,cAAeI,8BAAAA,wCAAAA,kBAAmBK,QAAQ,CAACD,OAAO;IAElE,MAAM,EAAEE,SAAS,EAAEC,kBAAkB,EAAE,GAAGd;IAE1C,MAAMe,iBAAiBjB,SAAS,OAAOkB;QACrC,mCAAmC;QACnC,IAAIT,mBAAmB;YACrB,MAAM,EAAEU,WAAW,EAAE,GAAGV,kBAAkBW,IAAI;YAC9C,MAAMC,sBAAsBC,wBAAwBH,aAAaD;YACjE,IAAIG,wBAAwBE,WAAW;gBACrC,OAAO;oBACLH,MAAMC,oBAAoBD,IAAI;oBAC9BI,UAAUC,wBAAwBnB,eAAe;wBAC/CO,SAASJ,kBAAkBK,QAAQ,CAACD,OAAO;wBAC3Ca,WAAWjB,kBAAkBK,QAAQ,CAACa,IAAI;wBAC1CA,MAAMN,oBAAoBM,IAAI;oBAChC;gBACF;YACF;QACF;QAEA,IAAId,SAAS;YACX,+DAA+D;YAC/D,MAAMe,aAAa,MAAMtB,cAAcuB,aAAa,CAAChB,SAASK;YAC9D,IAAIU,eAAeL,WAAW;gBAC5B,OAAO;oBACLH,MAAMQ,WAAWR,IAAI;oBACrBI,UAAUC,wBAAwBnB,eAAe;wBAC/CO,SAASe,WAAWd,QAAQ,CAACD,OAAO;wBACpCc,MAAMC,WAAWd,QAAQ,CAACa,IAAI;oBAChC;gBACF;YACF;QACF;QAEA,oEAAoE;QACpE,MAAMG,mBAAmB,MAAMxB,cAAcyB,mBAAmB,CAACb;QACjE,IAAIY,qBAAqBP,WAAW;YAClC,OAAO;gBACLH,MAAMU,iBAAiBV,IAAI;gBAC3BI,UAAUC,wBAAwBnB,eAAe;oBAC/CqB,MAAMG,iBAAiBhB,QAAQ,CAACa,IAAI;gBACtC;YACF;QACF;QAEA,MAAM,IAAIK,MAAM,CAAC,8BAA8B,EAAEd,SAASe,IAAI,CAAC,YAAY,EAAEf,SAASS,IAAI,CAAC,CAAC,CAAC;IAC/F;IAEA,8CAA8C;IAC9C,MAAME,gBAAgBhC,YACpB,OAAOqB;QACL,MAAM,EAAEE,IAAI,EAAE,GAAG,MAAMH,eAAeC;QACtC,OAAOE;IACT,GACA;QAACH;KAAe;IAGlB,gHAAgH;IAChH,MAAMiB,sBAAsBrC,YAC1B,eAAesC,UAA2CjB,QAA4B;QACpF,MAAM,EAAEe,IAAI,EAAE,GAAGf;QACjB,MAAM,CAAC,EAAEE,IAAI,EAAEI,QAAQ,EAAE,EAAEY,OAAO,GAAG,MAAMC,QAAQC,GAAG,CAAC;YAACrB,eAAeC;YAAWH,UAAU,cAAckB;SAAM;QAEhH,0BAA0B;QAC1B,MAAMM,SAASH,OAAOI,YAAY,CAACpB,KAAKgB,MAAM,CAAChB,IAAI,EAAE;YAAEI;QAAS;QAChE,IAAIjB,aAAagB,WAAW;YAC1B,OAAOhB,SAASgC;QAClB;QACA,OAAOA;IACT,GACA;QAACtB;QAAgBF;QAAWR;KAAS;IAGvC,MAAMkC,4BAA4BzC,SAChC,OAAO0C;QACL,MAAM,CAACC,gBAAgBxB,aAAayB,kBAAkB,GAAG,MAAMP,QAAQC,GAAG,CAAC;YACzEtB,mBAAmB;YACnBH,UAAUP,cAAcuC,eAAe,CAAChC,SAAS6B,wBAAwB,EAAE;YAC3EpC,cAAcwC,qBAAqB,CAACJ;SACrC;QAED,gHAAgH;QAChH,MAAMK,2BAA2BJ,eAAeK,IAAI,CAAC,CAAClC,WAAaA,SAASmB,IAAI,KAAKS;QACrF,IAAIK,6BAA6BxB,WAAW;YAC1C,MAAM,IAAIS,MAAM,CAAC,8CAA8C,EAAEU,qBAAqB,CAAC,CAAC;QAC1F;QAEA,4CAA4C;QAC5C,MAAM,EAAEO,OAAO,EAAEC,OAAO,EAAE,GAAGC,gCAAgCJ,yBAAyBK,OAAO,CAACzB,IAAI;QAElG,+DAA+D;QAC/D,IAAIlB,8BAAAA,wCAAAA,kBAAmBW,IAAI,CAACD,WAAW,EAAE;YACvC,IAAK,MAAMkC,gBAAgB5C,kBAAkBW,IAAI,CAACD,WAAW,CAAE;gBAC7D,MAAMC,OAAOX,kBAAkBW,IAAI,CAACD,WAAW,CAACkC,aAAa;gBAC7D,IAAIjC,SAASG,aAAaH,KAAKgB,MAAM,CAACH,IAAI,KAAKS,sBAAsB;gBAErE,MAAMY,QAAQD,gBAAgB1C;gBAC9BuC,QAAQ;oBAAE9B;oBAAMiC;oBAAcE,eAAe;oBAAaD;gBAAM;YAClE;QACF;QAEA,wCAAwC;QACxC,KAAK,MAAM1B,cAAcT,YAAa;YACpC,MAAMkC,eAAezB,WAAWd,QAAQ,CAACa,IAAI;YAC7CuB,QAAQ;gBACN9B,MAAMQ,WAAWR,IAAI;gBACrBiC;gBACAE,eAAe;gBACfC,UAAU,CAAC,UAAU,EAAE3C,QAAQ,YAAY,CAAC;YAC9C;QACF;QAEA,iCAAiC;QACjC,KAAK,MAAMiB,oBAAoBc,kBAAmB;YAChD,MAAMS,eAAevB,iBAAiBhB,QAAQ,CAACa,IAAI;YACnDuB,QAAQ;gBAAE9B,MAAMU,iBAAiBV,IAAI;gBAAEiC;gBAAcE,eAAe;gBAAUC,UAAU;YAAqB;QAC/G;QAEA,OAAOP;IACT;IAGF,MAAMQ,sBAAsB5D,YAAY;YAC/BY;QAAP,OAAOA,CAAAA,sCAAAA,8BAAAA,wCAAAA,kBAAmBW,IAAI,CAACD,WAAW,cAAnCV,iDAAAA,sCAAuC,CAAC;IACjD,GAAG;QAACA;KAAkB;IAEtB,MAAMiD,sBAAsB7D,YAAY;QACtC,OAAOc;IACT,GAAG;QAACA;KAAiB;IAErB,MAAMgD,sBAAsB9D,YAC1B,CAACsB;QACC,IAAIV,mBAAmB;YACrBC,qBACED,kBAAkBwB,IAAI,KAAK,cACtB;gBACC,GAAGxB,iBAAiB;gBACpBW,MAAM;oBACJ,GAAGX,kBAAkBW,IAAI;oBACzBD,aAAaA;gBACf;YACF,IACC;gBACC,GAAGV,iBAAiB;gBACpBW,MAAM;oBACJ,GAAGX,kBAAkBW,IAAI;oBACzBD,aAAaA;gBACf;YACF;QAER;IACF,GACA;QAACV;KAAkB;IAGrB,MAAMmD,WAA4B9D,QAChC,IACG,CAAA;YACC+B;YACAK;YACAuB;YACAE;YACA/C;YACA8C;YACAjB;QACF,CAAA,GACF;QACEZ;QACAK;QACAuB;QACAE;QACAlB;QACA7B;QACA8C;KACD;IAGH,qBAAO,KAACzD,uBAAuB4D,QAAQ;QAACC,OAAOF;kBAAWpD;;AAC5D;AAEA,SAASiB,wBAAwBsC,GAAkB,EAAEC,MAAqC;IACxF,OAAOD,IAAIE,aAAa,GAAGF,IAAIE,aAAa,CAACD,UAAU;AACzD;AAEA,uEAAuE;AACvE,SAAS1C,wBACP4C,oBAAkD,EAClDhD,QAA4B;IAE5B,IAAIgD,yBAAyB3C,WAAW,OAAOA;IAE/C,qCAAqC;IACrC,IAAIL,SAASS,IAAI,KAAKJ,WAAW;QAC/B,MAAM4C,QAAQD,oBAAoB,CAAChD,SAASS,IAAI,CAAC;QACjD,IAAIwC,UAAU5C,WAAW,OAAOA;QAChC,OAAO4C,MAAM/B,MAAM,CAACH,IAAI,KAAKf,SAASe,IAAI,GAAG;YAAEN,MAAMT,SAASS,IAAI;YAAEP,MAAM+C;QAAM,IAAI5C;IACtF;IAEA,2EAA2E;IAC3E,MAAM6C,SAASC,OAAOC,OAAO,CAACJ,sBAAsBlB,IAAI,CACtD,CAACuB,QAAUA,KAAK,CAAC,EAAE,CAACnC,MAAM,CAACH,IAAI,KAAKf,SAASe,IAAI,IAAIsC,KAAK,CAAC,EAAE,CAACC,OAAO;IAEvE,IAAI,CAACJ,QAAQ;QACX,OAAO7C;IACT;IACA,OAAO;QAAEI,MAAMyC,MAAM,CAAC,EAAE;QAAEhD,MAAMgD,MAAM,CAAC,EAAE;IAAC;AAC5C;AAYA;;;CAGC,GACD,SAASjB,gCAAgCsB,iBAAyB;IAIhE,MAAMxB,UAAuC,EAAE;IAC/C,MAAMyB,YAAY,IAAIC;IACtB,IAAIC,UAAU;IACd,IAAIC,uBAAuB;IAC3B,MAAMC,eAAuC,CAAC;IAC9C,IAAIC,oBAAoB,GAAG,+EAA+E;IAE1G,MAAM7B,UAAU,CAAC,EAAE9B,IAAI,EAAEiC,YAAY,EAAEE,eAAeyB,KAAK,EAAExB,QAAQ,EAAEF,KAAK,EAAgC;YAuBlGlC;QAtBR4D,QAAQA,kBAAAA,mBAAAA,QAAS;QAEjB,0EAA0E;QAC1E,IAAIJ,SAAS;YACX3B,QAAQgC,IAAI,CAAC;gBACXD,OAAO,CAAC,QAAQ,EAAEP,kBAAkB,CAAC;gBACrCS,OAAO,EAAE;YACX;QACF;YAG8BJ;QAD9B,gCAAgC;QAChC,IAAIK,kBAAkBlC,OAAO,CAAC6B,CAAAA,sBAAAA,YAAY,CAACE,MAAM,cAAnBF,iCAAAA,sBAAuB,CAAC,EAAE;QACxD,IAAI,CAACK,iBAAiB;YACpBL,YAAY,CAACE,MAAM,GAAGD;YACtBI,kBAAkB;gBAAED,OAAO,EAAE;gBAAEF;gBAAOxB;YAAS;YAC/CP,OAAO,CAAC8B,kBAAkB,GAAGI;YAC7BJ;QACF;QAEA,wBAAwB;QACxB,MAAMK,eAAeV,UAAUW,GAAG,CAAChC;YAE3BjC;QADR+D,gBAAgBD,KAAK,CAACD,IAAI,CAAC;YACzBtD,MAAMP,CAAAA,sBAAAA,gBAAAA,KAAKgC,OAAO,cAAZhC,oCAAAA,cAAcO,IAAI,cAAlBP,gCAAAA,qBAAsBiC;YAC5BiC,YAAYF;YACZ9B;YACApC,UAAU;gBACRe,MAAMb,KAAKgB,MAAM,CAACH,IAAI;gBACtBN,MAAM0B;gBACN2B;YACF;QACF;QACAN,UAAUa,GAAG,CAAClC;QAEd,MAAMmC,oBAAoB,CAACJ,gBAAgBhE,KAAKoD,OAAO,IAAI,CAACK;QAC5D,IAAI5B,OAAO,CAAC,EAAE,IAAK2B,CAAAA,WAAWY,iBAAgB,GAAI;YAChD,8GAA8G;YAC9GvC,OAAO,CAAC,EAAE,CAACiC,KAAK,GAAG;gBACjB;oBACEvD,MAAM,CAAC,SAAS,EAAE0B,aAAa,MAAM,EAAE2B,MAAM,CAAC,CAAC;oBAC/C9D,UAAU;wBACRe,MAAMb,KAAKgB,MAAM,CAACH,IAAI;oBACxB;gBACF;aACD;YACD,kGAAkG;YAClG,wGAAwG;YACxG,gDAAgD;YAChD4C,uBAAuBW;QACzB;QAEA,qEAAqE;QACrE,IAAIJ,cAAc;YAChB,IAAK,IAAIK,IAAIZ,uBAAuB,IAAI,GAAGY,IAAIV,mBAAmBU,IAAK;oBACpExC;oBAAAA;gBAAAA,CAAAA,CAAAA,oBAAAA,aAAAA,OAAO,CAACwC,EAAE,cAAVxC,iCAAAA,WAAYiC,KAAK,cAAjBjC,8BAAAA,mBAAqB,EAAE,AAAD,EACpByC,MAAM,CAAC,CAACC,OAA+BA,KAAKzE,QAAQ,CAACS,IAAI,KAAK0B,cAC9DuC,OAAO,CAAC,CAACD;oBACRA,KAAKE,UAAU,GAAG;gBACpB;YACJ;QACF;QAEAjB,UAAU;IACZ;IAEA,OAAO;QAAE3B;QAASC;IAAQ;AAC5B"}
+{"version":3,"sources":["../../src/context/DatasourceStoreProvider.tsx"],"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 { ReactElement, ReactNode, useCallback, useMemo, useState } from 'react';\nimport {\n  DashboardResource,\n  DashboardSpec,\n  DatasourceResource,\n  DatasourceSelector,\n  DatasourceSpec,\n  GlobalDatasourceResource,\n  useEvent,\n  EphemeralDashboardResource,\n  DatasourceDefinition,\n} from '@perses-dev/core';\nimport {\n  DatasourceStoreContext,\n  DatasourceStore,\n  DatasourceSelectItemGroup,\n  usePluginRegistry,\n  DatasourceClient,\n  DatasourceSelectItem,\n} from '@perses-dev/plugin-system';\n\nexport interface DatasourceStoreProviderProps {\n  dashboardResource?: DashboardResource | EphemeralDashboardResource;\n  projectName?: string;\n  datasourceApi: DatasourceApi;\n  children?: ReactNode;\n  savedDatasources?: Record<string, DatasourceSpec>;\n  onCreate?: (client: DatasourceClient) => DatasourceClient;\n}\n\nexport type BuildDatasourceProxyUrlParams = {\n  project?: string;\n  dashboard?: string;\n  name: string;\n};\n\nexport type BuildDatasourceProxyUrlFunc = (p: BuildDatasourceProxyUrlParams) => string;\n\n/**\n * The external API for fetching datasource resources\n */\nexport interface DatasourceApi {\n  buildProxyUrl?: BuildDatasourceProxyUrlFunc;\n  getDatasource: (project: string, selector: DatasourceSelector) => Promise<DatasourceResource | undefined>;\n  getGlobalDatasource: (selector: DatasourceSelector) => Promise<GlobalDatasourceResource | undefined>;\n  listDatasources: (project: string, pluginKind?: string) => Promise<DatasourceResource[]>;\n  listGlobalDatasources: (pluginKind?: string) => Promise<GlobalDatasourceResource[]>;\n}\n\n/**\n * A `DatasourceContext` provider that uses an external API to resolve datasource selectors.\n */\nexport function DatasourceStoreProvider(props: DatasourceStoreProviderProps): ReactElement {\n  const { projectName, datasourceApi, onCreate, children } = props;\n  const [dashboardResource, setDashboardResource] = useState(props.dashboardResource);\n  const [savedDatasources, setSavedDatasources] = useState<Record<string, DatasourceSpec>>(\n    props.savedDatasources ?? {}\n  );\n  const project = projectName ?? dashboardResource?.metadata.project;\n\n  const { getPlugin, listPluginMetadata } = usePluginRegistry();\n\n  const findDatasource = useEvent(async (selector: DatasourceSelector) => {\n    // Try to find it in dashboard spec\n    if (dashboardResource) {\n      const { datasources } = dashboardResource.spec;\n      const dashboardDatasource = findDashboardDatasource(datasources, selector);\n      if (dashboardDatasource !== undefined) {\n        return {\n          spec: dashboardDatasource.spec,\n          proxyUrl: buildDatasourceProxyUrl(datasourceApi, {\n            project: dashboardResource.metadata.project,\n            dashboard: dashboardResource.metadata.name,\n            name: dashboardDatasource.name,\n          }),\n        };\n      }\n    }\n\n    if (project) {\n      // Try to find it at the project level as a Datasource resource\n      const datasource = await datasourceApi.getDatasource(project, selector);\n      if (datasource !== undefined) {\n        return {\n          spec: datasource.spec,\n          proxyUrl: buildDatasourceProxyUrl(datasourceApi, {\n            project: datasource.metadata.project,\n            name: datasource.metadata.name,\n          }),\n        };\n      }\n    }\n\n    // Try to find it at the global level as a GlobalDatasource resource\n    const globalDatasource = await datasourceApi.getGlobalDatasource(selector);\n    if (globalDatasource !== undefined) {\n      return {\n        spec: globalDatasource.spec,\n        proxyUrl: buildDatasourceProxyUrl(datasourceApi, {\n          name: globalDatasource.metadata.name,\n        }),\n      };\n    }\n\n    throw new Error(`No datasource found for kind '${selector.kind}' and name '${selector.name}'`);\n  });\n\n  // Gets a datasource spec for a given selector\n  const getDatasource = useCallback(\n    async (selector: DatasourceSelector): Promise<DatasourceSpec> => {\n      const { spec } = await findDatasource(selector);\n      return spec;\n    },\n    [findDatasource]\n  );\n\n  // Given a Datasource selector, finds the spec for it and then uses its corresponding plugin the create a client\n  const getDatasourceClient = useCallback(\n    async function getClient<Client extends DatasourceClient>(selector: DatasourceSelector): Promise<Client> {\n      const { kind } = selector;\n      const [{ spec, proxyUrl }, plugin] = await Promise.all([findDatasource(selector), getPlugin('Datasource', kind)]);\n\n      // allows extending client\n      const client = plugin.createClient(spec.plugin.spec, { proxyUrl }) as Client;\n      if (onCreate !== undefined) {\n        return onCreate(client) as Client;\n      }\n      return client;\n    },\n    [findDatasource, getPlugin, onCreate]\n  );\n\n  const listDatasourceSelectItems = useEvent(\n    async (datasourcePluginName: string): Promise<DatasourceSelectItemGroup[]> => {\n      const [pluginMetadata, datasources, globalDatasources] = await Promise.all([\n        listPluginMetadata(['Datasource']),\n        project ? datasourceApi.listDatasources(project, datasourcePluginName) : [],\n        datasourceApi.listGlobalDatasources(datasourcePluginName),\n      ]);\n\n      // Find the metadata for the plugin type they asked for, so we can use it for the name of the default datasource\n      const datasourcePluginMetadata = pluginMetadata.find((metadata) => metadata.spec.name === datasourcePluginName);\n      if (datasourcePluginMetadata === undefined) {\n        throw new Error(`Could not find a Datasource plugin with kind '${datasourcePluginName}'`);\n      }\n\n      // Get helper for computing results properly\n      const { results, addItem } = buildDatasourceSelectItemGroups(datasourcePluginMetadata.spec.display.name);\n\n      // Start with dashboard datasources with the highest precedence\n      if (dashboardResource?.spec.datasources) {\n        for (const selectorName in dashboardResource.spec.datasources) {\n          const spec = dashboardResource.spec.datasources[selectorName];\n          if (spec === undefined || spec.plugin.kind !== datasourcePluginName) continue;\n\n          const saved = selectorName in savedDatasources;\n          addItem({ spec, selectorName, selectorGroup: 'dashboard', saved });\n        }\n      }\n\n      // Now look at project-level datasources\n      for (const datasource of datasources) {\n        const selectorName = datasource.metadata.name;\n        addItem({\n          spec: datasource.spec,\n          selectorName,\n          selectorGroup: 'project',\n          editLink: `/projects/${project}/datasources`,\n        });\n      }\n\n      // And finally global datasources\n      for (const globalDatasource of globalDatasources) {\n        const selectorName = globalDatasource.metadata.name;\n        addItem({ spec: globalDatasource.spec, selectorName, selectorGroup: 'global', editLink: '/admin/datasources' });\n      }\n\n      return results;\n    }\n  );\n\n  const getLocalDatasources = useCallback((): Record<string, DatasourceSpec> => {\n    return dashboardResource?.spec.datasources ?? {};\n  }, [dashboardResource]);\n\n  const getSavedDatasources = useCallback((): Record<string, DatasourceSpec> => {\n    return savedDatasources;\n  }, [savedDatasources]);\n\n  const setLocalDatasources = useCallback(\n    (datasources: Record<string, DatasourceSpec>) => {\n      if (dashboardResource) {\n        setDashboardResource(\n          dashboardResource.kind === 'Dashboard'\n            ? ({\n                ...dashboardResource,\n                spec: {\n                  ...dashboardResource.spec,\n                  datasources: datasources,\n                },\n              } as DashboardResource)\n            : ({\n                ...dashboardResource,\n                spec: {\n                  ...dashboardResource.spec,\n                  datasources: datasources,\n                },\n              } as EphemeralDashboardResource)\n        );\n      }\n    },\n    [dashboardResource]\n  );\n\n  const ctxValue: DatasourceStore = useMemo(\n    () =>\n      ({\n        getDatasource,\n        getDatasourceClient,\n        getLocalDatasources,\n        setLocalDatasources,\n        setSavedDatasources,\n        getSavedDatasources,\n        listDatasourceSelectItems,\n      }) as DatasourceStore,\n    [\n      getDatasource,\n      getDatasourceClient,\n      getLocalDatasources,\n      setLocalDatasources,\n      listDatasourceSelectItems,\n      setSavedDatasources,\n      getSavedDatasources,\n    ]\n  );\n\n  return <DatasourceStoreContext.Provider value={ctxValue}>{children}</DatasourceStoreContext.Provider>;\n}\n\nfunction buildDatasourceProxyUrl(api: DatasourceApi, params: BuildDatasourceProxyUrlParams): string {\n  return api.buildProxyUrl ? api.buildProxyUrl(params) : '';\n}\n\n// Helper to find a datasource in the list embedded in a dashboard spec\nfunction findDashboardDatasource(\n  dashboardDatasources: DashboardSpec['datasources'],\n  selector: DatasourceSelector\n): DatasourceDefinition | undefined {\n  if (dashboardDatasources === undefined) return undefined;\n\n  // If using a name in the selector...\n  if (selector.name !== undefined) {\n    const named = dashboardDatasources[selector.name];\n    if (named === undefined) return undefined;\n    return named.plugin.kind === selector.kind ? { name: selector.name, spec: named } : undefined;\n  }\n\n  // If only using a kind, try to find one with that kind that is the default\n  const result = Object.entries(dashboardDatasources).find(\n    (entry) => entry[1].plugin.kind === selector.kind && entry[1].default\n  );\n  if (!result) {\n    return undefined;\n  }\n  return { name: result[0], spec: result[1] };\n}\n\ninterface AddDatasouceSelectItemParams {\n  spec: DatasourceSpec;\n  selectorName: string;\n  selectorGroup?: string;\n  editLink?: string;\n  saved?: boolean;\n}\n\ntype AddDatasourceSelectItemFunc = (params: AddDatasouceSelectItemParams) => void;\n\n/**\n * Helper for building a list of DatasourceSelectItemGroup results.\n * @param pluginDisplayName\n */\nfunction buildDatasourceSelectItemGroups(pluginDisplayName: string): {\n  results: DatasourceSelectItemGroup[];\n  addItem: AddDatasourceSelectItemFunc;\n} {\n  const results: DatasourceSelectItemGroup[] = [];\n  const usedNames = new Set<string>();\n  let isFirst = true;\n  let explicitDefaultAdded = false;\n  const groupIndices: Record<string, number> = {};\n  let currentGroupIndex = 1; // 0 is the default group, always there as it contains at least the first item.\n\n  const addItem = ({\n    spec,\n    selectorName,\n    selectorGroup: group,\n    editLink,\n    saved,\n  }: AddDatasouceSelectItemParams): void => {\n    group = group ?? '';\n\n    // Ensure the default group is always present as soon as an item is added.\n    if (isFirst) {\n      results.push({\n        group: `Default ${pluginDisplayName}`,\n        items: [],\n      });\n    }\n\n    // Create the group if necessary\n    let selectItemGroup = results[groupIndices[group] ?? -1];\n    if (!selectItemGroup) {\n      groupIndices[group] = currentGroupIndex;\n      selectItemGroup = { items: [], group, editLink };\n      results[currentGroupIndex] = selectItemGroup;\n      currentGroupIndex++;\n    }\n\n    // Add item to the group\n    const isOverridden = usedNames.has(selectorName);\n    selectItemGroup.items.push({\n      name: spec.display?.name ?? selectorName,\n      overridden: isOverridden,\n      saved,\n      selector: {\n        kind: spec.plugin.kind,\n        name: selectorName,\n        group,\n      },\n    });\n    usedNames.add(selectorName);\n\n    const isExplicitDefault = !isOverridden && spec.default && !explicitDefaultAdded;\n    if (results[0] && (isFirst || isExplicitDefault)) {\n      // If we haven't added a default yet and this is a default, add default option to the beginning of the results\n      results[0].items = [\n        {\n          name: `Default (${selectorName} from ${group})`,\n          selector: {\n            kind: spec.plugin.kind,\n          },\n        },\n      ];\n      // We consider that we added the default datasource only if it has been explicitly set as default.\n      // If we add this datasource as default just because it's the first, it still needs to be overridable by\n      // another datasource explicitly set as default.\n      explicitDefaultAdded = isExplicitDefault;\n    }\n\n    // At the end, we make sure the overriding item(s) is well flagged so\n    if (isOverridden) {\n      for (let i = explicitDefaultAdded ? 1 : 0; i < currentGroupIndex; i++) {\n        (results[i]?.items ?? [])\n          .filter((item: DatasourceSelectItem) => item.selector.name === selectorName)\n          .forEach((item: DatasourceSelectItem) => {\n            item.overriding = true;\n          });\n      }\n    }\n\n    isFirst = false;\n  };\n\n  return { results, addItem };\n}\n"],"names":["useCallback","useMemo","useState","useEvent","DatasourceStoreContext","usePluginRegistry","DatasourceStoreProvider","props","projectName","datasourceApi","onCreate","children","dashboardResource","setDashboardResource","savedDatasources","setSavedDatasources","project","metadata","getPlugin","listPluginMetadata","findDatasource","selector","datasources","spec","dashboardDatasource","findDashboardDatasource","undefined","proxyUrl","buildDatasourceProxyUrl","dashboard","name","datasource","getDatasource","globalDatasource","getGlobalDatasource","Error","kind","getDatasourceClient","getClient","plugin","Promise","all","client","createClient","listDatasourceSelectItems","datasourcePluginName","pluginMetadata","globalDatasources","listDatasources","listGlobalDatasources","datasourcePluginMetadata","find","results","addItem","buildDatasourceSelectItemGroups","display","selectorName","saved","selectorGroup","editLink","getLocalDatasources","getSavedDatasources","setLocalDatasources","ctxValue","Provider","value","api","params","buildProxyUrl","dashboardDatasources","named","result","Object","entries","entry","default","pluginDisplayName","usedNames","Set","isFirst","explicitDefaultAdded","groupIndices","currentGroupIndex","group","push","items","selectItemGroup","isOverridden","has","overridden","add","isExplicitDefault","i","filter","item","forEach","overriding"],"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,SAAkCA,WAAW,EAAEC,OAAO,EAAEC,QAAQ,QAAQ,QAAQ;AAChF,SAOEC,QAAQ,QAGH,mBAAmB;AAC1B,SACEC,sBAAsB,EAGtBC,iBAAiB,QAGZ,4BAA4B;AA8BnC;;CAEC,GACD,OAAO,SAASC,wBAAwBC,KAAmC;IACzE,MAAM,EAAEC,WAAW,EAAEC,aAAa,EAAEC,QAAQ,EAAEC,QAAQ,EAAE,GAAGJ;IAC3D,MAAM,CAACK,mBAAmBC,qBAAqB,GAAGX,SAASK,MAAMK,iBAAiB;IAClF,MAAM,CAACE,kBAAkBC,oBAAoB,GAAGb,SAC9CK,MAAMO,gBAAgB,IAAI,CAAC;IAE7B,MAAME,UAAUR,eAAeI,mBAAmBK,SAASD;IAE3D,MAAM,EAAEE,SAAS,EAAEC,kBAAkB,EAAE,GAAGd;IAE1C,MAAMe,iBAAiBjB,SAAS,OAAOkB;QACrC,mCAAmC;QACnC,IAAIT,mBAAmB;YACrB,MAAM,EAAEU,WAAW,EAAE,GAAGV,kBAAkBW,IAAI;YAC9C,MAAMC,sBAAsBC,wBAAwBH,aAAaD;YACjE,IAAIG,wBAAwBE,WAAW;gBACrC,OAAO;oBACLH,MAAMC,oBAAoBD,IAAI;oBAC9BI,UAAUC,wBAAwBnB,eAAe;wBAC/CO,SAASJ,kBAAkBK,QAAQ,CAACD,OAAO;wBAC3Ca,WAAWjB,kBAAkBK,QAAQ,CAACa,IAAI;wBAC1CA,MAAMN,oBAAoBM,IAAI;oBAChC;gBACF;YACF;QACF;QAEA,IAAId,SAAS;YACX,+DAA+D;YAC/D,MAAMe,aAAa,MAAMtB,cAAcuB,aAAa,CAAChB,SAASK;YAC9D,IAAIU,eAAeL,WAAW;gBAC5B,OAAO;oBACLH,MAAMQ,WAAWR,IAAI;oBACrBI,UAAUC,wBAAwBnB,eAAe;wBAC/CO,SAASe,WAAWd,QAAQ,CAACD,OAAO;wBACpCc,MAAMC,WAAWd,QAAQ,CAACa,IAAI;oBAChC;gBACF;YACF;QACF;QAEA,oEAAoE;QACpE,MAAMG,mBAAmB,MAAMxB,cAAcyB,mBAAmB,CAACb;QACjE,IAAIY,qBAAqBP,WAAW;YAClC,OAAO;gBACLH,MAAMU,iBAAiBV,IAAI;gBAC3BI,UAAUC,wBAAwBnB,eAAe;oBAC/CqB,MAAMG,iBAAiBhB,QAAQ,CAACa,IAAI;gBACtC;YACF;QACF;QAEA,MAAM,IAAIK,MAAM,CAAC,8BAA8B,EAAEd,SAASe,IAAI,CAAC,YAAY,EAAEf,SAASS,IAAI,CAAC,CAAC,CAAC;IAC/F;IAEA,8CAA8C;IAC9C,MAAME,gBAAgBhC,YACpB,OAAOqB;QACL,MAAM,EAAEE,IAAI,EAAE,GAAG,MAAMH,eAAeC;QACtC,OAAOE;IACT,GACA;QAACH;KAAe;IAGlB,gHAAgH;IAChH,MAAMiB,sBAAsBrC,YAC1B,eAAesC,UAA2CjB,QAA4B;QACpF,MAAM,EAAEe,IAAI,EAAE,GAAGf;QACjB,MAAM,CAAC,EAAEE,IAAI,EAAEI,QAAQ,EAAE,EAAEY,OAAO,GAAG,MAAMC,QAAQC,GAAG,CAAC;YAACrB,eAAeC;YAAWH,UAAU,cAAckB;SAAM;QAEhH,0BAA0B;QAC1B,MAAMM,SAASH,OAAOI,YAAY,CAACpB,KAAKgB,MAAM,CAAChB,IAAI,EAAE;YAAEI;QAAS;QAChE,IAAIjB,aAAagB,WAAW;YAC1B,OAAOhB,SAASgC;QAClB;QACA,OAAOA;IACT,GACA;QAACtB;QAAgBF;QAAWR;KAAS;IAGvC,MAAMkC,4BAA4BzC,SAChC,OAAO0C;QACL,MAAM,CAACC,gBAAgBxB,aAAayB,kBAAkB,GAAG,MAAMP,QAAQC,GAAG,CAAC;YACzEtB,mBAAmB;gBAAC;aAAa;YACjCH,UAAUP,cAAcuC,eAAe,CAAChC,SAAS6B,wBAAwB,EAAE;YAC3EpC,cAAcwC,qBAAqB,CAACJ;SACrC;QAED,gHAAgH;QAChH,MAAMK,2BAA2BJ,eAAeK,IAAI,CAAC,CAAClC,WAAaA,SAASM,IAAI,CAACO,IAAI,KAAKe;QAC1F,IAAIK,6BAA6BxB,WAAW;YAC1C,MAAM,IAAIS,MAAM,CAAC,8CAA8C,EAAEU,qBAAqB,CAAC,CAAC;QAC1F;QAEA,4CAA4C;QAC5C,MAAM,EAAEO,OAAO,EAAEC,OAAO,EAAE,GAAGC,gCAAgCJ,yBAAyB3B,IAAI,CAACgC,OAAO,CAACzB,IAAI;QAEvG,+DAA+D;QAC/D,IAAIlB,mBAAmBW,KAAKD,aAAa;YACvC,IAAK,MAAMkC,gBAAgB5C,kBAAkBW,IAAI,CAACD,WAAW,CAAE;gBAC7D,MAAMC,OAAOX,kBAAkBW,IAAI,CAACD,WAAW,CAACkC,aAAa;gBAC7D,IAAIjC,SAASG,aAAaH,KAAKgB,MAAM,CAACH,IAAI,KAAKS,sBAAsB;gBAErE,MAAMY,QAAQD,gBAAgB1C;gBAC9BuC,QAAQ;oBAAE9B;oBAAMiC;oBAAcE,eAAe;oBAAaD;gBAAM;YAClE;QACF;QAEA,wCAAwC;QACxC,KAAK,MAAM1B,cAAcT,YAAa;YACpC,MAAMkC,eAAezB,WAAWd,QAAQ,CAACa,IAAI;YAC7CuB,QAAQ;gBACN9B,MAAMQ,WAAWR,IAAI;gBACrBiC;gBACAE,eAAe;gBACfC,UAAU,CAAC,UAAU,EAAE3C,QAAQ,YAAY,CAAC;YAC9C;QACF;QAEA,iCAAiC;QACjC,KAAK,MAAMiB,oBAAoBc,kBAAmB;YAChD,MAAMS,eAAevB,iBAAiBhB,QAAQ,CAACa,IAAI;YACnDuB,QAAQ;gBAAE9B,MAAMU,iBAAiBV,IAAI;gBAAEiC;gBAAcE,eAAe;gBAAUC,UAAU;YAAqB;QAC/G;QAEA,OAAOP;IACT;IAGF,MAAMQ,sBAAsB5D,YAAY;QACtC,OAAOY,mBAAmBW,KAAKD,eAAe,CAAC;IACjD,GAAG;QAACV;KAAkB;IAEtB,MAAMiD,sBAAsB7D,YAAY;QACtC,OAAOc;IACT,GAAG;QAACA;KAAiB;IAErB,MAAMgD,sBAAsB9D,YAC1B,CAACsB;QACC,IAAIV,mBAAmB;YACrBC,qBACED,kBAAkBwB,IAAI,KAAK,cACtB;gBACC,GAAGxB,iBAAiB;gBACpBW,MAAM;oBACJ,GAAGX,kBAAkBW,IAAI;oBACzBD,aAAaA;gBACf;YACF,IACC;gBACC,GAAGV,iBAAiB;gBACpBW,MAAM;oBACJ,GAAGX,kBAAkBW,IAAI;oBACzBD,aAAaA;gBACf;YACF;QAER;IACF,GACA;QAACV;KAAkB;IAGrB,MAAMmD,WAA4B9D,QAChC,IACG,CAAA;YACC+B;YACAK;YACAuB;YACAE;YACA/C;YACA8C;YACAjB;QACF,CAAA,GACF;QACEZ;QACAK;QACAuB;QACAE;QACAlB;QACA7B;QACA8C;KACD;IAGH,qBAAO,KAACzD,uBAAuB4D,QAAQ;QAACC,OAAOF;kBAAWpD;;AAC5D;AAEA,SAASiB,wBAAwBsC,GAAkB,EAAEC,MAAqC;IACxF,OAAOD,IAAIE,aAAa,GAAGF,IAAIE,aAAa,CAACD,UAAU;AACzD;AAEA,uEAAuE;AACvE,SAAS1C,wBACP4C,oBAAkD,EAClDhD,QAA4B;IAE5B,IAAIgD,yBAAyB3C,WAAW,OAAOA;IAE/C,qCAAqC;IACrC,IAAIL,SAASS,IAAI,KAAKJ,WAAW;QAC/B,MAAM4C,QAAQD,oBAAoB,CAAChD,SAASS,IAAI,CAAC;QACjD,IAAIwC,UAAU5C,WAAW,OAAOA;QAChC,OAAO4C,MAAM/B,MAAM,CAACH,IAAI,KAAKf,SAASe,IAAI,GAAG;YAAEN,MAAMT,SAASS,IAAI;YAAEP,MAAM+C;QAAM,IAAI5C;IACtF;IAEA,2EAA2E;IAC3E,MAAM6C,SAASC,OAAOC,OAAO,CAACJ,sBAAsBlB,IAAI,CACtD,CAACuB,QAAUA,KAAK,CAAC,EAAE,CAACnC,MAAM,CAACH,IAAI,KAAKf,SAASe,IAAI,IAAIsC,KAAK,CAAC,EAAE,CAACC,OAAO;IAEvE,IAAI,CAACJ,QAAQ;QACX,OAAO7C;IACT;IACA,OAAO;QAAEI,MAAMyC,MAAM,CAAC,EAAE;QAAEhD,MAAMgD,MAAM,CAAC,EAAE;IAAC;AAC5C;AAYA;;;CAGC,GACD,SAASjB,gCAAgCsB,iBAAyB;IAIhE,MAAMxB,UAAuC,EAAE;IAC/C,MAAMyB,YAAY,IAAIC;IACtB,IAAIC,UAAU;IACd,IAAIC,uBAAuB;IAC3B,MAAMC,eAAuC,CAAC;IAC9C,IAAIC,oBAAoB,GAAG,+EAA+E;IAE1G,MAAM7B,UAAU,CAAC,EACf9B,IAAI,EACJiC,YAAY,EACZE,eAAeyB,KAAK,EACpBxB,QAAQ,EACRF,KAAK,EACwB;QAC7B0B,QAAQA,SAAS;QAEjB,0EAA0E;QAC1E,IAAIJ,SAAS;YACX3B,QAAQgC,IAAI,CAAC;gBACXD,OAAO,CAAC,QAAQ,EAAEP,kBAAkB,CAAC;gBACrCS,OAAO,EAAE;YACX;QACF;QAEA,gCAAgC;QAChC,IAAIC,kBAAkBlC,OAAO,CAAC6B,YAAY,CAACE,MAAM,IAAI,CAAC,EAAE;QACxD,IAAI,CAACG,iBAAiB;YACpBL,YAAY,CAACE,MAAM,GAAGD;YACtBI,kBAAkB;gBAAED,OAAO,EAAE;gBAAEF;gBAAOxB;YAAS;YAC/CP,OAAO,CAAC8B,kBAAkB,GAAGI;YAC7BJ;QACF;QAEA,wBAAwB;QACxB,MAAMK,eAAeV,UAAUW,GAAG,CAAChC;QACnC8B,gBAAgBD,KAAK,CAACD,IAAI,CAAC;YACzBtD,MAAMP,KAAKgC,OAAO,EAAEzB,QAAQ0B;YAC5BiC,YAAYF;YACZ9B;YACApC,UAAU;gBACRe,MAAMb,KAAKgB,MAAM,CAACH,IAAI;gBACtBN,MAAM0B;gBACN2B;YACF;QACF;QACAN,UAAUa,GAAG,CAAClC;QAEd,MAAMmC,oBAAoB,CAACJ,gBAAgBhE,KAAKoD,OAAO,IAAI,CAACK;QAC5D,IAAI5B,OAAO,CAAC,EAAE,IAAK2B,CAAAA,WAAWY,iBAAgB,GAAI;YAChD,8GAA8G;YAC9GvC,OAAO,CAAC,EAAE,CAACiC,KAAK,GAAG;gBACjB;oBACEvD,MAAM,CAAC,SAAS,EAAE0B,aAAa,MAAM,EAAE2B,MAAM,CAAC,CAAC;oBAC/C9D,UAAU;wBACRe,MAAMb,KAAKgB,MAAM,CAACH,IAAI;oBACxB;gBACF;aACD;YACD,kGAAkG;YAClG,wGAAwG;YACxG,gDAAgD;YAChD4C,uBAAuBW;QACzB;QAEA,qEAAqE;QACrE,IAAIJ,cAAc;YAChB,IAAK,IAAIK,IAAIZ,uBAAuB,IAAI,GAAGY,IAAIV,mBAAmBU,IAAK;gBACpExC,CAAAA,OAAO,CAACwC,EAAE,EAAEP,SAAS,EAAE,AAAD,EACpBQ,MAAM,CAAC,CAACC,OAA+BA,KAAKzE,QAAQ,CAACS,IAAI,KAAK0B,cAC9DuC,OAAO,CAAC,CAACD;oBACRA,KAAKE,UAAU,GAAG;gBACpB;YACJ;QACF;QAEAjB,UAAU;IACZ;IAEA,OAAO;QAAE3B;QAASC;IAAQ;AAC5B"}

package/dist/context/VariableProvider/VariableProvider.d.ts

@@ -0,0 +1,119 @@
+import { ReactElement, ReactNode } from 'react';
+import { StoreApi } from 'zustand';
+import { VariableStateMap, VariableState, VariableStoreStateMap, VariableOption } from '@perses-dev/plugin-system';
+import { VariableName, VariableValue, VariableDefinition, BuiltinVariableDefinition, TextVariableDefinition, ListVariableDefinition } from '@perses-dev/core';
+/**
+ * This store is used to manipulate and read the definition of the variables and their state.
+ * - being local or external variables.
+ * - being text or list variables.
+ * - being of any state (value, options, loading, error, ...) check {@VariableState}
+ * Go and read each property documentation for more details.
+ */
+type VariableDefinitionStore = {
+    /**
+     * List of local variables definitions.
+     * This is typically the variable definition that can be modified through the setVariableDefinition setter.
+     *
+     * In Perses App ecosystem, this is typically the dashboard scope variables, that's why we call them local.
+     * Note that depending on the form, we can reuse this store to modify higher scope variables. For example,
+     * when we modify the variable of a project, we'll set this field with project scope variables. To be able to modify
+     * them.
+     */
+    variableDefinitions: VariableDefinition[];
+    /**
+     * List of external variable definitions.
+     * This is static variable definitions that won´t be modified under this context.
+     * You'll have to set one list of external variable definition by scope. See {@link ExternalVariableDefinition} for
+     * more details.
+     *
+     * In Perses App ecosystem, this is typically the project or global scope variables.
+     * Note that depending on the form, we can reuse this store to modify higher scope variables. For example,
+     * when we modify the variable of a project, we'll set this field with global scope variables. Which means we
+     * won't be able to modify them from this form.
+     */
+    externalVariableDefinitions: ExternalVariableDefinition[];
+    /**
+     * Additionally to definitions, we need to associate to each variable a state. That's what this map is meant for.
+     * This can be heavily modified under this context, using the different setters available.
+     * Note that the state of local AND external variables can be modified.
+     */
+    variableState: VariableStoreStateMap;
+    /**
+     * Allow to modify the `value` property of a variable in the state map.
+     * @param variableName identify the variable
+     * @param value new value
+     * @param source identify the variable source if this is an external variable. See {@link ExternalVariableDefinition}
+     */
+    setVariableValue: (variableName: VariableName, value: VariableValue, source?: string) => void;
+    /**
+     * Allow to modify the `options` property of a variable in the state map.
+     * @param variableName identify the variable
+     * @param options new value
+     * @param source identify the variable source if this is an external variable. See {@link ExternalVariableDefinition}
+     */
+    setVariableOptions: (name: VariableName, options: VariableOption[], source?: string) => void;
+    /**
+     * Allow to modify the `loading` property of a variable in the state map.
+     * @param variableName identify the variable
+     * @param laoding new value
+     * @param source identify the variable source if this is an external variable. See {@link ExternalVariableDefinition}
+     */
+    setVariableLoading: (name: VariableName, loading: boolean, source?: string) => void;
+    setVariableDefinitions: (definitions: VariableDefinition[]) => void;
+    setVariableDefaultValues: () => VariableDefinition[];
+    getSavedVariablesStatus: () => {
+        isSavedVariableModified: boolean;
+        modifiedVariableNames: string[];
+    };
+};
+export declare function useVariableDefinitionStoreCtx(): StoreApi<VariableDefinitionStore>;
+export declare function useVariableDefinitionStates(variableNames?: string[]): VariableStateMap;
+/**
+ * Get the state and definition of a variable from the variables context.
+ * @param name name of the variable
+ * @param source if given, it searches in the external variables
+ */
+export declare function useVariableDefinitionAndState(name: string, source?: string): {
+    definition: TextVariableDefinition | ListVariableDefinition | undefined;
+    state: VariableState | undefined;
+};
+export declare function useVariableDefinitionActions(): {
+    setVariableLoading: (name: VariableName, loading: boolean, source?: string) => void;
+    getSavedVariablesStatus: () => {
+        isSavedVariableModified: boolean;
+        modifiedVariableNames: string[];
+    };
+    setVariableDefaultValues: () => VariableDefinition[];
+    setVariableValue: (variableName: VariableName, value: VariableValue, source?: string) => void;
+    setVariableOptions: (name: VariableName, options: VariableOption[], source?: string) => void;
+    setVariableDefinitions: (definitions: VariableDefinition[]) => void;
+};
+export declare function useVariableDefinitions(): VariableDefinition[];
+export declare function useExternalVariableDefinitions(): ExternalVariableDefinition[];
+/**
+ * The external variables allow you to give to the provider some additional variables, not defined in the dashboard and static.
+ * It means that you won´t be able to update them from the dashboard itself, but you will see them appear and will be able
+ * to modify their runtime value as any other variable.
+ * If one of the external variable has the same name as a local one, it will be marked as overridden.
+ * You can define one list of variable definition by source and as many source as you want.
+ * The order of the sources is important as first one will take precedence on the following ones, in case they have same names.
+ */
+export type ExternalVariableDefinition = {
+    source: string;
+    tooltip?: {
+        title?: string;
+        description?: string;
+    };
+    editLink?: string;
+    definitions: VariableDefinition[];
+};
+export interface VariableProviderProps {
+    children: ReactNode;
+    initialVariableDefinitions?: VariableDefinition[];
+    externalVariableDefinitions?: ExternalVariableDefinition[];
+    builtinVariableDefinitions?: BuiltinVariableDefinition[];
+}
+export declare function VariableProvider({ children, initialVariableDefinitions, externalVariableDefinitions, builtinVariableDefinitions, }: VariableProviderProps): ReactElement;
+export declare function VariableProviderWithQueryParams({ children, initialVariableDefinitions, externalVariableDefinitions, builtinVariableDefinitions: builtinVariables, }: VariableProviderProps): ReactElement;
+export {};
+//# sourceMappingURL=VariableProvider.d.ts.map

package/dist/context/VariableProvider/VariableProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VariableProvider.d.ts","sourceRoot":"","sources":["../../../src/context/VariableProvider/VariableProvider.tsx"],"names":[],"mappings":"AAaA,OAAO,EAAiB,YAAY,EAAE,SAAS,EAAiC,MAAM,OAAO,CAAC;AAC9F,OAAO,EAAe,QAAQ,EAAY,MAAM,SAAS,CAAC;AAK1D,OAAO,EAEL,gBAAgB,EAChB,aAAa,EACb,qBAAqB,EACrB,cAAc,EAGf,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAEL,YAAY,EACZ,aAAa,EACb,kBAAkB,EAGlB,yBAAyB,EACzB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,kBAAkB,CAAC;AAK1B;;;;;;GAMG;AACH,KAAK,uBAAuB,GAAG;IAC7B;;;;;;;;OAQG;IACH,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C;;;;;;;;;;OAUG;IACH,2BAA2B,EAAE,0BAA0B,EAAE,CAAC;IAC1D;;;;OAIG;IACH,aAAa,EAAE,qBAAqB,CAAC;IACrC;;;;;OAKG;IACH,gBAAgB,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9F;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7F;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACpF,sBAAsB,EAAE,CAAC,WAAW,EAAE,kBAAkB,EAAE,KAAK,IAAI,CAAC;IACpE,wBAAwB,EAAE,MAAM,kBAAkB,EAAE,CAAC;IACrD,uBAAuB,EAAE,MAAM;QAAE,uBAAuB,EAAE,OAAO,CAAC;QAAC,qBAAqB,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CACtG,CAAC;AAMF,wBAAgB,6BAA6B,IAAI,QAAQ,CAAC,uBAAuB,CAAC,CAMjF;AAED,wBAAgB,2BAA2B,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAoCtF;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC3C,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,GACd;IACD,UAAU,EAAE,sBAAsB,GAAG,sBAAsB,GAAG,SAAS,CAAC;IACxE,KAAK,EAAE,aAAa,GAAG,SAAS,CAAC;CAClC,CAWA;AAED,wBAAgB,4BAA4B,IAAI;IAC9C,kBAAkB,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACpF,uBAAuB,EAAE,MAAM;QAAE,uBAAuB,EAAE,OAAO,CAAC;QAAC,qBAAqB,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IACrG,wBAAwB,EAAE,MAAM,kBAAkB,EAAE,CAAC;IACrD,gBAAgB,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9F,kBAAkB,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7F,sBAAsB,EAAE,CAAC,WAAW,EAAE,kBAAkB,EAAE,KAAK,IAAI,CAAC;CACrE,CAYA;AAED,wBAAgB,sBAAsB,IAAI,kBAAkB,EAAE,CAG7D;AAED,wBAAgB,8BAA8B,IAAI,0BAA0B,EAAE,CAG7E;AA+PD;;;;;;;GAOG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,kBAAkB,EAAE,CAAC;CACnC,CAAC;AAEF,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,SAAS,CAAC;IACpB,0BAA0B,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAClD,2BAA2B,CAAC,EAAE,0BAA0B,EAAE,CAAC;IAC3D,0BAA0B,CAAC,EAAE,yBAAyB,EAAE,CAAC;CAC1D;AAGD,wBAAgB,gBAAgB,CAAC,EAC/B,QAAQ,EACR,0BAA+B,EAC/B,2BAAgC,EAChC,0BAA+B,GAChC,EAAE,qBAAqB,GAAG,YAAY,CAQtC;AAED,wBAAgB,+BAA+B,CAAC,EAC9C,QAAQ,EACR,0BAA+B,EAC/B,2BAAgC,EAChC,0BAA0B,EAAE,gBAAqB,GAClD,EAAE,qBAAqB,GAAG,YAAY,CAYtC"}

package/dist/context/{TemplateVariableProvider/TemplateVariableProvider.js → VariableProvider/VariableProvider.js}

@@ -1,4 +1,4 @@
-// Copyright 2023 The Perses Authors
+// Copyright 2024 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
@@ -13,28 +13,31 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { createContext, useContext, useMemo, useState } from 'react';
 import { createStore, useStore } from 'zustand';
+import { useStoreWithEqualityFn } from 'zustand/traditional';
 import { immer } from 'zustand/middleware/immer';
 import { devtools } from 'zustand/middleware';
 import produce from 'immer';
-import { TemplateVariableContext, BuiltinVariableContext, useTimeRange } from '@perses-dev/plugin-system';
+import { VariableContext, BuiltinVariableContext, useTimeRange } from '@perses-dev/plugin-system';
 import { DEFAULT_ALL_VALUE as ALL_VALUE, formatDuration, intervalToPrometheusDuration } from '@perses-dev/core';
 import { checkSavedDefaultVariableStatus, findVariableDefinitionByName, mergeVariableDefinitions } from './utils';
-import { hydrateTemplateVariableStates } from './hydrationUtils';
+import { hydrateVariableDefinitionStates as hydrateVariableDefinitionStates } from './hydrationUtils';
 import { getInitalValuesFromQueryParameters, getURLQueryParamName, useVariableQueryParams } from './query-params';
-const TemplateVariableStoreContext = /*#__PURE__*/ createContext(undefined);
-export function useTemplateVariableStoreCtx() {
-    const context = useContext(TemplateVariableStoreContext);
+/**
+ * Context object for {@link VariableDefinitionStore}.
+ */ const VariableDefinitionStoreContext = /*#__PURE__*/ createContext(undefined);
+export function useVariableDefinitionStoreCtx() {
+    const context = useContext(VariableDefinitionStoreContext);
     if (!context) {
-        throw new Error('TemplateVariableStoreContext not initialized');
+        throw new Error('VariableStoreContext not initialized');
     }
     return context;
 }
-export function useTemplateVariableValues(variableNames) {
-    const store = useTemplateVariableStoreCtx();
-    return useStore(store, (s)=>{
-        const vars = {};
+export function useVariableDefinitionStates(variableNames) {
+    const store = useVariableDefinitionStoreCtx();
+    return useStoreWithEqualityFn(store, (s)=>{
+        const varStates = {};
         // Collect values of local variables, from the variable state
-        const names = variableNames !== null && variableNames !== void 0 ? variableNames : s.variableDefinitions.map((value)=>value.spec.name);
+        const names = variableNames ?? s.variableDefinitions.map((value)=>value.spec.name);
         names.forEach((name)=>{
             const varState = s.variableState.get({
                 name
@@ -42,7 +45,7 @@ export function useTemplateVariableValues(variableNames) {
             if (!varState || varState.overridden) {
                 return;
             }
-            vars[name] = varState;
+            varStates[name] = varState;
         });
         // Collect values of external variables, from the variable state
         s.externalVariableDefinitions.forEach((d)=>{
@@ -56,27 +59,26 @@ export function useTemplateVariableValues(variableNames) {
                 if (!varState || varState.overridden) {
                     return;
                 }
-                vars[name] = varState;
+                varStates[name] = varState;
             });
         });
-        return vars;
+        return varStates;
     }, (left, right)=>{
         return JSON.stringify(left) === JSON.stringify(right);
     });
 }
 /**
- * Get the state and definition of a variable from the Template variables context.
+ * Get the state and definition of a variable from the variables context.
  * @param name name of the variable
  * @param source if given, it searches in the external variables
- */ export function useTemplateVariable(name, source) {
-    const store = useTemplateVariableStoreCtx();
+ */ export function useVariableDefinitionAndState(name, source) {
+    const store = useVariableDefinitionStoreCtx();
     return useStore(store, (s)=>{
-        var _s_externalVariableDefinitions_find;
         const state = s.variableState.get({
             name,
             source
         });
-        const definitions = source ? (_s_externalVariableDefinitions_find = s.externalVariableDefinitions.find((v)=>v.source === source)) === null || _s_externalVariableDefinitions_find === void 0 ? void 0 : _s_externalVariableDefinitions_find.definitions : s.variableDefinitions;
+        const definitions = source ? s.externalVariableDefinitions.find((v)=>v.source === source)?.definitions : s.variableDefinitions;
         const definition = (definitions || []).find((v)=>v.spec.name === name);
         return {
             state,
@@ -84,8 +86,8 @@ export function useTemplateVariableValues(variableNames) {
         };
     });
 }
-export function useTemplateVariableActions() {
-    const store = useTemplateVariableStoreCtx();
+export function useVariableDefinitionActions() {
+    const store = useVariableDefinitionStoreCtx();
     return useStore(store, (s)=>{
         return {
             setVariableValue: s.setVariableValue,
@@ -97,22 +99,18 @@ export function useTemplateVariableActions() {
         };
     });
 }
-export function useTemplateVariableDefinitions() {
-    const store = useTemplateVariableStoreCtx();
+export function useVariableDefinitions() {
+    const store = useVariableDefinitionStoreCtx();
     return useStore(store, (s)=>s.variableDefinitions);
 }
-export function useTemplateExternalVariableDefinitions() {
-    const store = useTemplateVariableStoreCtx();
+export function useExternalVariableDefinitions() {
+    const store = useVariableDefinitionStoreCtx();
     return useStore(store, (s)=>s.externalVariableDefinitions);
 }
-export function useTemplateVariableStore() {
-    const store = useTemplateVariableStoreCtx();
-    return useStore(store);
-}
 function PluginProvider({ children, builtinVariables }) {
-    const originalValues = useTemplateVariableValues();
-    const definitions = useTemplateVariableDefinitions();
-    const externalDefinitions = useTemplateExternalVariableDefinitions();
+    const originalValues = useVariableDefinitionStates();
+    const definitions = useVariableDefinitions();
+    const externalDefinitions = useExternalVariableDefinitions();
     const { absoluteTimeRange } = useTimeRange();
     const values = useMemo(()=>{
         const contextValues = {};
@@ -126,12 +124,10 @@ function PluginProvider({ children, builtinVariables }) {
             if (v.value === ALL_VALUE) {
                 const definition = findVariableDefinitionByName(name, definitions, externalDefinitions);
                 // If the variable is a list variable and has a custom all value, then use that value instead
-                if ((definition === null || definition === void 0 ? void 0 : definition.kind) === 'ListVariable' && definition.spec.customAllValue) {
+                if (definition?.kind === 'ListVariable' && definition.spec.customAllValue) {
                     v.value = definition.spec.customAllValue;
                 } else {
-                    var _v_options;
-                    var _v_options_map;
-                    v.value = (_v_options_map = (_v_options = v.options) === null || _v_options === void 0 ? void 0 : _v_options.map((o)=>o.value)) !== null && _v_options_map !== void 0 ? _v_options_map : null;
+                    v.value = v.options?.map((o)=>o.value) ?? null;
                 }
             }
             contextValues[name] = v;
@@ -210,7 +206,7 @@ function PluginProvider({ children, builtinVariables }) {
                 }
             }
         ];
-        builtinVariables === null || builtinVariables === void 0 ? void 0 : builtinVariables.forEach((def)=>result.push(def));
+        builtinVariables?.forEach((def)=>result.push(def));
         return result;
     }, [
         absoluteTimeRange,
@@ -220,7 +216,7 @@ function PluginProvider({ children, builtinVariables }) {
         value: {
             variables: allBuiltinVariables
         },
-        children: /*#__PURE__*/ _jsx(TemplateVariableContext.Provider, {
+        children: /*#__PURE__*/ _jsx(VariableContext.Provider, {
             value: {
                 state: values
             },
@@ -228,16 +224,16 @@ function PluginProvider({ children, builtinVariables }) {
         })
     });
 }
-function createTemplateVariableSrvStore({ initialVariableDefinitions = [], externalVariableDefinitions = [], queryParams }) {
+function createVariableDefinitionStore({ initialVariableDefinitions = [], externalVariableDefinitions = [], queryParams }) {
     const initialParams = getInitalValuesFromQueryParameters(queryParams ? queryParams[0] : {});
     const store = createStore()(devtools(immer((set, get)=>({
-            variableState: hydrateTemplateVariableStates(initialVariableDefinitions, initialParams, externalVariableDefinitions),
+            variableState: hydrateVariableDefinitionStates(initialVariableDefinitions, initialParams, externalVariableDefinitions),
             variableDefinitions: initialVariableDefinitions,
             externalVariableDefinitions: externalVariableDefinitions,
             setVariableDefinitions (definitions) {
                 set((state)=>{
                     state.variableDefinitions = definitions;
-                    state.variableState = hydrateTemplateVariableStates(definitions, initialParams, externalVariableDefinitions);
+                    state.variableState = hydrateVariableDefinitionStates(definitions, initialParams, externalVariableDefinitions);
                 }, false, '[Variables] setVariableDefinitions' // Used for action name in Redux devtools
                 );
             },
@@ -300,7 +296,7 @@ function createTemplateVariableSrvStore({ initialVariableDefinitions = [], exter
                             const currentVariable = variableState.get({
                                 name
                             });
-                            if ((currentVariable === null || currentVariable === void 0 ? void 0 : currentVariable.value) !== undefined) {
+                            if (currentVariable?.value !== undefined) {
                                 draft[index] = {
                                     kind: 'ListVariable',
                                     spec: produce(variable.spec, (specDraft)=>{
@@ -312,8 +308,8 @@ function createTemplateVariableSrvStore({ initialVariableDefinitions = [], exter
                             const currentVariable = variableState.get({
                                 name
                             });
-                            const currentVariableValue = typeof (currentVariable === null || currentVariable === void 0 ? void 0 : currentVariable.value) === 'string' ? currentVariable.value : '';
-                            if ((currentVariable === null || currentVariable === void 0 ? void 0 : currentVariable.value) !== undefined) {
+                            const currentVariableValue = typeof currentVariable?.value === 'string' ? currentVariable.value : '';
+                            if (currentVariable?.value !== undefined) {
                                 draft[index] = {
                                     kind: 'TextVariable',
                                     spec: produce(variable.spec, (specDraft)=>{
@@ -333,30 +329,31 @@ function createTemplateVariableSrvStore({ initialVariableDefinitions = [], exter
                 return checkSavedDefaultVariableStatus(get().variableDefinitions, get().variableState);
             }
         }))));
-    return store;
+    return store; // TODO: @Gladorme check if we can avoid this cast
 }
-export function TemplateVariableProvider({ children, initialVariableDefinitions = [], externalVariableDefinitions = [], builtinVariables = [] }) {
-    const [store] = useState(createTemplateVariableSrvStore({
+// TODO: merge the different providers related to Variables under a single one (and keep "VariableProvider" as a name)
+export function VariableProvider({ children, initialVariableDefinitions = [], externalVariableDefinitions = [], builtinVariableDefinitions = [] }) {
+    const [store] = useState(createVariableDefinitionStore({
         initialVariableDefinitions,
         externalVariableDefinitions
     }));
-    return /*#__PURE__*/ _jsx(TemplateVariableStoreContext.Provider, {
+    return /*#__PURE__*/ _jsx(VariableDefinitionStoreContext.Provider, {
         value: store,
         children: /*#__PURE__*/ _jsx(PluginProvider, {
-            builtinVariables: builtinVariables,
+            builtinVariables: builtinVariableDefinitions,
             children: children
         })
     });
 }
-export function TemplateVariableProviderWithQueryParams({ children, initialVariableDefinitions = [], externalVariableDefinitions = [], builtinVariables = [] }) {
+export function VariableProviderWithQueryParams({ children, initialVariableDefinitions = [], externalVariableDefinitions = [], builtinVariableDefinitions: builtinVariables = [] }) {
     const allVariableDefs = mergeVariableDefinitions(initialVariableDefinitions, externalVariableDefinitions);
     const queryParams = useVariableQueryParams(allVariableDefs);
-    const [store] = useState(createTemplateVariableSrvStore({
+    const [store] = useState(createVariableDefinitionStore({
         initialVariableDefinitions,
         externalVariableDefinitions,
         queryParams
     }));
-    return /*#__PURE__*/ _jsx(TemplateVariableStoreContext.Provider, {
+    return /*#__PURE__*/ _jsx(VariableDefinitionStoreContext.Provider, {
         value: store,
         children: /*#__PURE__*/ _jsx(PluginProvider, {
             builtinVariables: builtinVariables,
@@ -365,4 +362,4 @@ export function TemplateVariableProviderWithQueryParams({ children, initialVaria
     });
 }
 
-//# sourceMappingURL=TemplateVariableProvider.js.map
+//# sourceMappingURL=VariableProvider.js.map