@perses-dev/dashboards 0.38.0 → 0.40.0

package/dist/context/DatasourceStoreProvider.js

@@ -27,8 +27,12 @@ import { DatasourceStoreContext, usePluginRegistry } from '@perses-dev/plugin-sy
             const dashboardDatasource = findDashboardDatasource(datasources, selector);
             if (dashboardDatasource !== undefined) {
                 return {
-                    spec: dashboardDatasource,
-                    proxyUrl: undefined
+                    spec: dashboardDatasource.spec,
+                    proxyUrl: buildDatasourceProxyUrl(datasourceApi, {
+                        project: dashboardResource.metadata.project,
+                        dashboard: dashboardResource.metadata.name,
+                        name: dashboardDatasource.name
+                    })
                 };
             }
         }
@@ -37,8 +41,11 @@ import { DatasourceStoreContext, usePluginRegistry } from '@perses-dev/plugin-sy
             const datasource = await datasourceApi.getDatasource(project, selector);
             if (datasource !== undefined) {
                 return {
-                    spec: datasource.resource.spec,
-                    proxyUrl: datasource.proxyUrl
+                    spec: datasource.spec,
+                    proxyUrl: buildDatasourceProxyUrl(datasourceApi, {
+                        project: datasource.metadata.project,
+                        name: datasource.metadata.name
+                    })
                 };
             }
         }
@@ -46,8 +53,10 @@ import { DatasourceStoreContext, usePluginRegistry } from '@perses-dev/plugin-sy
         const globalDatasource = await datasourceApi.getGlobalDatasource(selector);
         if (globalDatasource !== undefined) {
             return {
-                spec: globalDatasource.resource.spec,
-                proxyUrl: globalDatasource.proxyUrl
+                spec: globalDatasource.spec,
+                proxyUrl: buildDatasourceProxyUrl(datasourceApi, {
+                    name: globalDatasource.metadata.name
+                })
             };
         }
         throw new Error(`No datasource found for kind '${selector.kind}' and name '${selector.name}'`);
@@ -79,53 +88,56 @@ import { DatasourceStoreContext, usePluginRegistry } from '@perses-dev/plugin-sy
         getPlugin,
         onCreate
     ]);
-    const listDatasourceMetadata = useEvent(async (datasourcePluginKind)=>{
+    const listDatasourceSelectItems = useEvent(async (datasourcePluginKind)=>{
         const [pluginMetadata, datasources, globalDatasources] = await Promise.all([
             listPluginMetadata('Datasource'),
             project ? datasourceApi.listDatasources(project, datasourcePluginKind) : [],
             datasourceApi.listGlobalDatasources(datasourcePluginKind)
         ]);
-        // Find the metadata for the plugin type they asked for so we can use it for the name of the default datasource
+        // 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);
         if (datasourcePluginMetadata === undefined) {
             throw new Error(`Could not find a Datasource plugin with kind '${datasourcePluginKind}'`);
         }
-        // Get helper for de-duping results properly
-        const { results , addResult  } = buildListDatasourceMetadataResults(datasourcePluginMetadata.display.name);
-        // Start with dashboard datasources that have highest precedence
+        // Get helper for computing results properly
+        const { results , addItem  } = buildDatasourceSelectItemGroups(datasourcePluginMetadata.display.name);
+        // Start with dashboard datasources with the highest precedence
         if (dashboardResource === null || dashboardResource === void 0 ? void 0 : dashboardResource.spec.datasources) {
             for(const selectorName in dashboardResource.spec.datasources){
                 const spec = dashboardResource.spec.datasources[selectorName];
                 if (spec === undefined || spec.plugin.kind !== datasourcePluginKind) continue;
-                addResult(spec, selectorName);
+                addItem(spec, selectorName, 'dashboard');
             }
         }
         // Now look at project-level datasources
         for (const datasource of datasources){
-            const selectorName1 = datasource.metadata.name;
-            addResult(datasource.spec, selectorName1);
+            const selectorName = datasource.metadata.name;
+            addItem(datasource.spec, selectorName, 'project', `/projects/${project}/datasources`);
         }
         // And finally global datasources
         for (const globalDatasource of globalDatasources){
-            const selectorName2 = globalDatasource.metadata.name;
-            addResult(globalDatasource.spec, selectorName2);
+            const selectorName = globalDatasource.metadata.name;
+            addItem(globalDatasource.spec, selectorName, 'global', '/admin/datasources');
         }
         return results;
     });
     const ctxValue = useMemo(()=>({
             getDatasource,
             getDatasourceClient,
-            listDatasourceMetadata
+            listDatasourceSelectItems
         }), [
         getDatasource,
         getDatasourceClient,
-        listDatasourceMetadata
+        listDatasourceSelectItems
     ]);
     return /*#__PURE__*/ _jsx(DatasourceStoreContext.Provider, {
         value: ctxValue,
         children: children
     });
 }
+function buildDatasourceProxyUrl(api, params) {
+    return api.buildProxyUrl ? api.buildProxyUrl(params) : '';
+}
 // Helper to find a datasource in the list embedded in a dashboard spec
 function findDashboardDatasource(dashboardDatasources, selector) {
     if (dashboardDatasources === undefined) return undefined;
@@ -133,43 +145,98 @@ function findDashboardDatasource(dashboardDatasources, selector) {
     if (selector.name !== undefined) {
         const named = dashboardDatasources[selector.name];
         if (named === undefined) return undefined;
-        return named.plugin.kind === selector.kind ? named : undefined;
+        return named.plugin.kind === selector.kind ? {
+            name: selector.name,
+            spec: named
+        } : undefined;
     }
     // If only using a kind, try to find one with that kind that is the default
-    return Object.values(dashboardDatasources).find((ds)=>ds.plugin.kind === selector.kind && ds.default === true);
+    const result = Object.entries(dashboardDatasources).find((entry)=>entry[1].plugin.kind === selector.kind && entry[1].default);
+    if (!result) {
+        return undefined;
+    }
+    return {
+        name: result[0],
+        spec: result[1]
+    };
 }
-// Helper for building a list of DatasourceMetadata results that will take care of de-duping already used selectors
-function buildListDatasourceMetadataResults(pluginDisplayName) {
+/**
+ * Helper for building a list of DatasourceSelectItemGroup results.
+ * @param pluginDisplayName
+ */ function buildDatasourceSelectItemGroups(pluginDisplayName) {
     const results = [];
     const usedNames = new Set();
-    let defaultAdded = false;
-    const addResult = (spec, selectorName)=>{
-        var ref;
-        // If we haven't added a default yet and this is a default, add default option to the beginning of the results
-        if (spec.default && defaultAdded === false) {
-            results.unshift({
-                name: `Default ${pluginDisplayName}`,
-                selector: {
-                    kind: spec.plugin.kind
-                }
+    let isFirst = true;
+    let explicitDefaultAdded = false;
+    const groupIndices = {};
+    let currentGroupIndex = 1; // 0 is the default group, always there as it contains at least the first item.
+    const addItem = (spec, selectorName, group, editLink)=>{
+        var _spec_display;
+        group = group !== null && group !== void 0 ? group : '';
+        // Ensure the default group is always present as soon as an item is added.
+        if (isFirst) {
+            results.push({
+                group: `Default ${pluginDisplayName}`,
+                items: []
             });
-            defaultAdded = true;
         }
-        // If we already have a datasource with this selector name, ignore it, otherwise add to end of list
-        if (usedNames.has(selectorName)) return;
-        var ref1;
-        results.push({
-            name: (ref1 = (ref = spec.display) === null || ref === void 0 ? void 0 : ref.name) !== null && ref1 !== void 0 ? ref1 : selectorName,
+        var _groupIndices_group;
+        // Create the group if necessary
+        let selectItemGroup = results[(_groupIndices_group = groupIndices[group]) !== null && _groupIndices_group !== void 0 ? _groupIndices_group : -1];
+        if (!selectItemGroup) {
+            groupIndices[group] = currentGroupIndex;
+            selectItemGroup = {
+                items: [],
+                group,
+                editLink
+            };
+            results[currentGroupIndex] = selectItemGroup;
+            currentGroupIndex++;
+        }
+        // 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,
+            overridden: isOverridden,
             selector: {
                 kind: spec.plugin.kind,
-                name: selectorName
+                name: selectorName,
+                group
             }
         });
         usedNames.add(selectorName);
+        const isExplicitDefault = !isOverridden && spec.default && !explicitDefaultAdded;
+        if (results[0] && (isFirst || isExplicitDefault)) {
+            // If we haven't added a default yet and this is a default, add default option to the beginning of the results
+            results[0].items = [
+                {
+                    name: `Default (${selectorName} from ${group})`,
+                    selector: {
+                        kind: spec.plugin.kind
+                    }
+                }
+            ];
+            // We consider that we added the default datasource only if it has been explicitly set as default.
+            // If we add this datasource as default just because it's the first, it still needs to be overridable by
+            // another datasource explicitly set as default.
+            explicitDefaultAdded = isExplicitDefault;
+        }
+        // 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)=>{
+                    item.overriding = true;
+                });
+            }
+        }
+        isFirst = false;
     };
     return {
         results,
-        addResult
+        addItem
     };
 }
 

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 } from 'react';\nimport {\n  DashboardResource,\n  DashboardSpec,\n  Datasource,\n  DatasourceSelector,\n  DatasourceSpec,\n  GlobalDatasource,\n  useEvent,\n} from '@perses-dev/core';\nimport {\n  DatasourceStoreContext,\n  DatasourceStore,\n  usePluginRegistry,\n  DatasourceMetadata,\n  DatasourceClient,\n} from '@perses-dev/plugin-system';\n\nexport interface DatasourceStoreProviderProps {\n  dashboardResource?: DashboardResource;\n  projectName?: string;\n  datasourceApi: DatasourceApi;\n  children?: ReactNode;\n  onCreate?: (client: DatasourceClient) => DatasourceClient;\n}\n\n// The external API for fetching datasource resources\nexport interface DatasourceApi {\n  getDatasource: (\n    project: string,\n    selector: DatasourceSelector\n  ) => Promise<{ resource: Datasource; proxyUrl: string } | undefined>;\n\n  getGlobalDatasource: (\n    selector: DatasourceSelector\n  ) => Promise<{ resource: GlobalDatasource; proxyUrl: string } | undefined>;\n\n  listDatasources: (project: string, pluginKind?: string) => Promise<Datasource[]>;\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 { dashboardResource, projectName, datasourceApi, onCreate, children } = props;\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 { spec: dashboardDatasource, proxyUrl: undefined };\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 { spec: datasource.resource.spec, proxyUrl: datasource.proxyUrl };\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 { spec: globalDatasource.resource.spec, proxyUrl: globalDatasource.proxyUrl };\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 listDatasourceMetadata = useEvent(async (datasourcePluginKind: string): Promise<DatasourceMetadata[]> => {\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 de-duping results properly\n    const { results, addResult } = buildListDatasourceMetadataResults(datasourcePluginMetadata.display.name);\n\n    // Start with dashboard datasources that have 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        addResult(spec, selectorName);\n      }\n    }\n\n    // Now look at project-level datasources\n    for (const datasource of datasources) {\n      const selectorName = datasource.metadata.name;\n      addResult(datasource.spec, selectorName);\n    }\n\n    // And finally global datasources\n    for (const globalDatasource of globalDatasources) {\n      const selectorName = globalDatasource.metadata.name;\n      addResult(globalDatasource.spec, selectorName);\n    }\n\n    return results;\n  });\n\n  const ctxValue: DatasourceStore = useMemo(\n    () => ({\n      getDatasource,\n      getDatasourceClient,\n      listDatasourceMetadata,\n    }),\n    [getDatasource, getDatasourceClient, listDatasourceMetadata]\n  );\n\n  return <DatasourceStoreContext.Provider value={ctxValue}>{children}</DatasourceStoreContext.Provider>;\n}\n\n// Helper to find a datasource in the list embedded in a dashboard spec\nfunction findDashboardDatasource(dashboardDatasources: DashboardSpec['datasources'], selector: DatasourceSelector) {\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 ? named : undefined;\n  }\n\n  // If only using a kind, try to find one with that kind that is the default\n  return Object.values(dashboardDatasources).find((ds) => ds.plugin.kind === selector.kind && ds.default === true);\n}\n\n// Helper for building a list of DatasourceMetadata results that will take care of de-duping already used selectors\nfunction buildListDatasourceMetadataResults(pluginDisplayName: string) {\n  const results: DatasourceMetadata[] = [];\n  const usedNames = new Set<string>();\n  let defaultAdded = false;\n  const addResult = (spec: DatasourceSpec, selectorName: string) => {\n    // If we haven't added a default yet and this is a default, add default option to the beginning of the results\n    if (spec.default && defaultAdded === false) {\n      results.unshift({\n        name: `Default ${pluginDisplayName}`,\n        selector: {\n          kind: spec.plugin.kind,\n        },\n      });\n      defaultAdded = true;\n    }\n\n    // If we already have a datasource with this selector name, ignore it, otherwise add to end of list\n    if (usedNames.has(selectorName)) return;\n\n    results.push({\n      name: spec.display?.name ?? selectorName,\n      selector: {\n        kind: spec.plugin.kind,\n        name: selectorName,\n      },\n    });\n    usedNames.add(selectorName);\n  };\n\n  return { results, addResult };\n}\n"],"names":["useCallback","useMemo","useEvent","DatasourceStoreContext","usePluginRegistry","DatasourceStoreProvider","props","dashboardResource","projectName","datasourceApi","onCreate","children","project","metadata","getPlugin","listPluginMetadata","findDatasource","selector","datasources","spec","dashboardDatasource","findDashboardDatasource","undefined","proxyUrl","datasource","getDatasource","resource","globalDatasource","getGlobalDatasource","Error","kind","name","getDatasourceClient","getClient","plugin","Promise","all","client","createClient","listDatasourceMetadata","datasourcePluginKind","pluginMetadata","globalDatasources","listDatasources","listGlobalDatasources","datasourcePluginMetadata","find","results","addResult","buildListDatasourceMetadataResults","display","selectorName","ctxValue","Provider","value","dashboardDatasources","named","Object","values","ds","default","pluginDisplayName","usedNames","Set","defaultAdded","unshift","has","push","add"],"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;AAAA,SAAoBA,WAAW,EAAEC,OAAO,QAAQ,OAAO,CAAC;AACxD,SAOEC,QAAQ,QACH,kBAAkB,CAAC;AAC1B,SACEC,sBAAsB,EAEtBC,iBAAiB,QAGZ,2BAA2B,CAAC;AA0BnC;;CAEC,GACD,OAAO,SAASC,uBAAuB,CAACC,KAAmC,EAAE;IAC3E,MAAM,EAAEC,iBAAiB,CAAA,EAAEC,WAAW,CAAA,EAAEC,aAAa,CAAA,EAAEC,QAAQ,CAAA,EAAEC,QAAQ,CAAA,EAAE,GAAGL,KAAK,AAAC;IACpF,MAAMM,OAAO,GAAGJ,WAAW,aAAXA,WAAW,cAAXA,WAAW,GAAID,iBAAiB,aAAjBA,iBAAiB,WAAU,GAA3BA,KAAAA,CAA2B,GAA3BA,iBAAiB,CAAEM,QAAQ,CAACD,OAAO,AAAC;IAEnE,MAAM,EAAEE,SAAS,CAAA,EAAEC,kBAAkB,CAAA,EAAE,GAAGX,iBAAiB,EAAE,AAAC;IAE9D,MAAMY,cAAc,GAAGd,QAAQ,CAAC,OAAOe,QAA4B,GAAK;QACtE,mCAAmC;QACnC,IAAIV,iBAAiB,EAAE;YACrB,MAAM,EAAEW,WAAW,CAAA,EAAE,GAAGX,iBAAiB,CAACY,IAAI,AAAC;YAC/C,MAAMC,mBAAmB,GAAGC,uBAAuB,CAACH,WAAW,EAAED,QAAQ,CAAC,AAAC;YAC3E,IAAIG,mBAAmB,KAAKE,SAAS,EAAE;gBACrC,OAAO;oBAAEH,IAAI,EAAEC,mBAAmB;oBAAEG,QAAQ,EAAED,SAAS;iBAAE,CAAC;YAC5D,CAAC;QACH,CAAC;QAED,IAAIV,OAAO,EAAE;YACX,+DAA+D;YAC/D,MAAMY,UAAU,GAAG,MAAMf,aAAa,CAACgB,aAAa,CAACb,OAAO,EAAEK,QAAQ,CAAC,AAAC;YACxE,IAAIO,UAAU,KAAKF,SAAS,EAAE;gBAC5B,OAAO;oBAAEH,IAAI,EAAEK,UAAU,CAACE,QAAQ,CAACP,IAAI;oBAAEI,QAAQ,EAAEC,UAAU,CAACD,QAAQ;iBAAE,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,oEAAoE;QACpE,MAAMI,gBAAgB,GAAG,MAAMlB,aAAa,CAACmB,mBAAmB,CAACX,QAAQ,CAAC,AAAC;QAC3E,IAAIU,gBAAgB,KAAKL,SAAS,EAAE;YAClC,OAAO;gBAAEH,IAAI,EAAEQ,gBAAgB,CAACD,QAAQ,CAACP,IAAI;gBAAEI,QAAQ,EAAEI,gBAAgB,CAACJ,QAAQ;aAAE,CAAC;QACvF,CAAC;QAED,MAAM,IAAIM,KAAK,CAAC,CAAC,8BAA8B,EAAEZ,QAAQ,CAACa,IAAI,CAAC,YAAY,EAAEb,QAAQ,CAACc,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACjG,CAAC,CAAC,AAAC;IAEH,8CAA8C;IAC9C,MAAMN,aAAa,GAAGzB,WAAW,CAC/B,OAAOiB,QAA4B,GAA8B;QAC/D,MAAM,EAAEE,IAAI,CAAA,EAAE,GAAG,MAAMH,cAAc,CAACC,QAAQ,CAAC,AAAC;QAChD,OAAOE,IAAI,CAAC;IACd,CAAC,EACD;QAACH,cAAc;KAAC,CACjB,AAAC;IAEF,gHAAgH;IAChH,MAAMgB,mBAAmB,GAAGhC,WAAW,CACrC,eAAeiC,SAAS,CAAkChB,QAA4B,EAAmB;QACvG,MAAM,EAAEa,IAAI,CAAA,EAAE,GAAGb,QAAQ,AAAC;QAC1B,MAAM,CAAC,EAAEE,IAAI,CAAA,EAAEI,QAAQ,CAAA,EAAE,EAAEW,MAAM,CAAC,GAAG,MAAMC,OAAO,CAACC,GAAG,CAAC;YAACpB,cAAc,CAACC,QAAQ,CAAC;YAAEH,SAAS,CAAC,YAAY,EAAEgB,IAAI,CAAC;SAAC,CAAC,AAAC;QAElH,0BAA0B;QAC1B,MAAMO,MAAM,GAAGH,MAAM,CAACI,YAAY,CAACnB,IAAI,CAACe,MAAM,CAACf,IAAI,EAAE;YAAEI,QAAQ;SAAE,CAAC,AAAU,AAAC;QAC7E,IAAIb,QAAQ,KAAKY,SAAS,EAAE;YAC1B,OAAOZ,QAAQ,CAAC2B,MAAM,CAAC,CAAW;QACpC,CAAC;QACD,OAAOA,MAAM,CAAC;IAChB,CAAC,EACD;QAACrB,cAAc;QAAEF,SAAS;QAAEJ,QAAQ;KAAC,CACtC,AAAC;IAEF,MAAM6B,sBAAsB,GAAGrC,QAAQ,CAAC,OAAOsC,oBAA4B,GAAoC;QAC7G,MAAM,CAACC,cAAc,EAAEvB,WAAW,EAAEwB,iBAAiB,CAAC,GAAG,MAAMP,OAAO,CAACC,GAAG,CAAC;YACzErB,kBAAkB,CAAC,YAAY,CAAC;YAChCH,OAAO,GAAGH,aAAa,CAACkC,eAAe,CAAC/B,OAAO,EAAE4B,oBAAoB,CAAC,GAAG,EAAE;YAC3E/B,aAAa,CAACmC,qBAAqB,CAACJ,oBAAoB,CAAC;SAC1D,CAAC,AAAC;QAEH,+GAA+G;QAC/G,MAAMK,wBAAwB,GAAGJ,cAAc,CAACK,IAAI,CAAC,CAACjC,QAAQ,GAAKA,QAAQ,CAACiB,IAAI,KAAKU,oBAAoB,CAAC,AAAC;QAC3G,IAAIK,wBAAwB,KAAKvB,SAAS,EAAE;YAC1C,MAAM,IAAIO,KAAK,CAAC,CAAC,8CAA8C,EAAEW,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5F,CAAC;QAED,4CAA4C;QAC5C,MAAM,EAAEO,OAAO,CAAA,EAAEC,SAAS,CAAA,EAAE,GAAGC,kCAAkC,CAACJ,wBAAwB,CAACK,OAAO,CAACnB,IAAI,CAAC,AAAC;QAEzG,gEAAgE;QAChE,IAAIxB,iBAAiB,aAAjBA,iBAAiB,WAAM,GAAvBA,KAAAA,CAAuB,GAAvBA,iBAAiB,CAAEY,IAAI,CAACD,WAAW,EAAE;YACvC,IAAK,MAAMiC,YAAY,IAAI5C,iBAAiB,CAACY,IAAI,CAACD,WAAW,CAAE;gBAC7D,MAAMC,IAAI,GAAGZ,iBAAiB,CAACY,IAAI,CAACD,WAAW,CAACiC,YAAY,CAAC,AAAC;gBAC9D,IAAIhC,IAAI,KAAKG,SAAS,IAAIH,IAAI,CAACe,MAAM,CAACJ,IAAI,KAAKU,oBAAoB,EAAE,SAAS;gBAC9EQ,SAAS,CAAC7B,IAAI,EAAEgC,YAAY,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;QAED,wCAAwC;QACxC,KAAK,MAAM3B,UAAU,IAAIN,WAAW,CAAE;YACpC,MAAMiC,aAAY,GAAG3B,UAAU,CAACX,QAAQ,CAACkB,IAAI,AAAC;YAC9CiB,SAAS,CAACxB,UAAU,CAACL,IAAI,EAAEgC,aAAY,CAAC,CAAC;QAC3C,CAAC;QAED,iCAAiC;QACjC,KAAK,MAAMxB,gBAAgB,IAAIe,iBAAiB,CAAE;YAChD,MAAMS,aAAY,GAAGxB,gBAAgB,CAACd,QAAQ,CAACkB,IAAI,AAAC;YACpDiB,SAAS,CAACrB,gBAAgB,CAACR,IAAI,EAAEgC,aAAY,CAAC,CAAC;QACjD,CAAC;QAED,OAAOJ,OAAO,CAAC;IACjB,CAAC,CAAC,AAAC;IAEH,MAAMK,QAAQ,GAAoBnD,OAAO,CACvC,IAAO,CAAA;YACLwB,aAAa;YACbO,mBAAmB;YACnBO,sBAAsB;SACvB,CAAA,AAAC,EACF;QAACd,aAAa;QAAEO,mBAAmB;QAAEO,sBAAsB;KAAC,CAC7D,AAAC;IAEF,qBAAO,KAACpC,sBAAsB,CAACkD,QAAQ;QAACC,KAAK,EAAEF,QAAQ;kBAAGzC,QAAQ;MAAmC,CAAC;AACxG,CAAC;AAED,uEAAuE;AACvE,SAASU,uBAAuB,CAACkC,oBAAkD,EAAEtC,QAA4B,EAAE;IACjH,IAAIsC,oBAAoB,KAAKjC,SAAS,EAAE,OAAOA,SAAS,CAAC;IAEzD,qCAAqC;IACrC,IAAIL,QAAQ,CAACc,IAAI,KAAKT,SAAS,EAAE;QAC/B,MAAMkC,KAAK,GAAGD,oBAAoB,CAACtC,QAAQ,CAACc,IAAI,CAAC,AAAC;QAClD,IAAIyB,KAAK,KAAKlC,SAAS,EAAE,OAAOA,SAAS,CAAC;QAC1C,OAAOkC,KAAK,CAACtB,MAAM,CAACJ,IAAI,KAAKb,QAAQ,CAACa,IAAI,GAAG0B,KAAK,GAAGlC,SAAS,CAAC;IACjE,CAAC;IAED,2EAA2E;IAC3E,OAAOmC,MAAM,CAACC,MAAM,CAACH,oBAAoB,CAAC,CAACT,IAAI,CAAC,CAACa,EAAE,GAAKA,EAAE,CAACzB,MAAM,CAACJ,IAAI,KAAKb,QAAQ,CAACa,IAAI,IAAI6B,EAAE,CAACC,OAAO,KAAK,IAAI,CAAC,CAAC;AACnH,CAAC;AAED,mHAAmH;AACnH,SAASX,kCAAkC,CAACY,iBAAyB,EAAE;IACrE,MAAMd,OAAO,GAAyB,EAAE,AAAC;IACzC,MAAMe,SAAS,GAAG,IAAIC,GAAG,EAAU,AAAC;IACpC,IAAIC,YAAY,GAAG,KAAK,AAAC;IACzB,MAAMhB,SAAS,GAAG,CAAC7B,IAAoB,EAAEgC,YAAoB,GAAK;YAgBxDhC,GAAY;QAfpB,8GAA8G;QAC9G,IAAIA,IAAI,CAACyC,OAAO,IAAII,YAAY,KAAK,KAAK,EAAE;YAC1CjB,OAAO,CAACkB,OAAO,CAAC;gBACdlC,IAAI,EAAE,CAAC,QAAQ,EAAE8B,iBAAiB,CAAC,CAAC;gBACpC5C,QAAQ,EAAE;oBACRa,IAAI,EAAEX,IAAI,CAACe,MAAM,CAACJ,IAAI;iBACvB;aACF,CAAC,CAAC;YACHkC,YAAY,GAAG,IAAI,CAAC;QACtB,CAAC;QAED,mGAAmG;QACnG,IAAIF,SAAS,CAACI,GAAG,CAACf,YAAY,CAAC,EAAE,OAAO;YAGhChC,IAAkB;QAD1B4B,OAAO,CAACoB,IAAI,CAAC;YACXpC,IAAI,EAAEZ,CAAAA,IAAkB,GAAlBA,CAAAA,GAAY,GAAZA,IAAI,CAAC+B,OAAO,cAAZ/B,GAAY,WAAM,GAAlBA,KAAAA,CAAkB,GAAlBA,GAAY,CAAEY,IAAI,cAAlBZ,IAAkB,cAAlBA,IAAkB,GAAIgC,YAAY;YACxClC,QAAQ,EAAE;gBACRa,IAAI,EAAEX,IAAI,CAACe,MAAM,CAACJ,IAAI;gBACtBC,IAAI,EAAEoB,YAAY;aACnB;SACF,CAAC,CAAC;QACHW,SAAS,CAACM,GAAG,CAACjB,YAAY,CAAC,CAAC;IAC9B,CAAC,AAAC;IAEF,OAAO;QAAEJ,OAAO;QAAEC,SAAS;KAAE,CAAC;AAChC,CAAC"}
+{"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 } from 'react';\nimport {\n  DashboardResource,\n  DashboardSpec,\n  ProjectDatasource,\n  DatasourceSelector,\n  DatasourceSpec,\n  GlobalDatasource,\n  useEvent,\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;\n  projectName?: string;\n  datasourceApi: DatasourceApi;\n  children?: ReactNode;\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 { dashboardResource, projectName, datasourceApi, onCreate, children } = props;\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          addItem(spec, selectorName, 'dashboard');\n        }\n      }\n\n      // Now look at project-level datasources\n      for (const datasource of datasources) {\n        const selectorName = datasource.metadata.name;\n        addItem(datasource.spec, selectorName, 'project', `/projects/${project}/datasources`);\n      }\n\n      // And finally global datasources\n      for (const globalDatasource of globalDatasources) {\n        const selectorName = globalDatasource.metadata.name;\n        addItem(globalDatasource.spec, selectorName, 'global', '/admin/datasources');\n      }\n\n      return results;\n    }\n  );\n\n  const ctxValue: DatasourceStore = useMemo(\n    () => ({\n      getDatasource,\n      getDatasourceClient,\n      listDatasourceSelectItems,\n    }),\n    [getDatasource, getDatasourceClient, listDatasourceSelectItems]\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): { name: string; spec: DatasourceSpec } | 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\ntype AddDatasourceSelectItemFunc = (\n  spec: DatasourceSpec,\n  selectorName: string,\n  selectorGroup?: string,\n  editLink?: string\n) => 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: DatasourceSpec, selectorName: string, group?: string, editLink?: string) => {\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      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","useEvent","DatasourceStoreContext","usePluginRegistry","DatasourceStoreProvider","props","dashboardResource","projectName","datasourceApi","onCreate","children","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","ctxValue","Provider","value","api","params","buildProxyUrl","dashboardDatasources","named","result","Object","entries","entry","default","pluginDisplayName","usedNames","Set","isFirst","explicitDefaultAdded","groupIndices","currentGroupIndex","group","editLink","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,QAAQ,QAAQ;AACxD,SAOEC,QAAQ,QACH,mBAAmB;AAC1B,SACEC,sBAAsB,EAGtBC,iBAAiB,QAGZ,4BAA4B;AAiCnC;;CAEC,GACD,OAAO,SAASC,wBAAwBC,KAAmC;IACzE,MAAM,EAAEC,kBAAiB,EAAEC,YAAW,EAAEC,cAAa,EAAEC,SAAQ,EAAEC,SAAQ,EAAE,GAAGL;IAC9E,MAAMM,UAAUJ,wBAAAA,yBAAAA,cAAeD,8BAAAA,+BAAAA,KAAAA,IAAAA,kBAAmBM,SAASD;IAE3D,MAAM,EAAEE,UAAS,EAAEC,mBAAkB,EAAE,GAAGX;IAE1C,MAAMY,iBAAiBd,SAAS,OAAOe;QACrC,mCAAmC;QACnC,IAAIV,mBAAmB;YACrB,MAAM,EAAEW,YAAW,EAAE,GAAGX,kBAAkBY;YAC1C,MAAMC,sBAAsBC,wBAAwBH,aAAaD;YACjE,IAAIG,wBAAwBE,WAAW;gBACrC,OAAO;oBACLH,MAAMC,oBAAoBD;oBAC1BI,UAAUC,wBAAwBf,eAAe;wBAC/CG,SAASL,kBAAkBM,SAASD;wBACpCa,WAAWlB,kBAAkBM,SAASa;wBACtCA,MAAMN,oBAAoBM;oBAC5B;gBACF;YACF;QACF;QAEA,IAAId,SAAS;YACX,+DAA+D;YAC/D,MAAMe,aAAa,MAAMlB,cAAcmB,cAAchB,SAASK;YAC9D,IAAIU,eAAeL,WAAW;gBAC5B,OAAO;oBACLH,MAAMQ,WAAWR;oBACjBI,UAAUC,wBAAwBf,eAAe;wBAC/CG,SAASe,WAAWd,SAASD;wBAC7Bc,MAAMC,WAAWd,SAASa;oBAC5B;gBACF;YACF;QACF;QAEA,oEAAoE;QACpE,MAAMG,mBAAmB,MAAMpB,cAAcqB,oBAAoBb;QACjE,IAAIY,qBAAqBP,WAAW;YAClC,OAAO;gBACLH,MAAMU,iBAAiBV;gBACvBI,UAAUC,wBAAwBf,eAAe;oBAC/CiB,MAAMG,iBAAiBhB,SAASa;gBAClC;YACF;QACF;QAEA,MAAM,IAAIK,MAAM,CAAC,8BAA8B,EAAEd,SAASe,KAAK,YAAY,EAAEf,SAASS,KAAK,CAAC,CAAC;IAC/F;IAEA,8CAA8C;IAC9C,MAAME,gBAAgB5B,YACpB,OAAOiB;QACL,MAAM,EAAEE,KAAI,EAAE,GAAG,MAAMH,eAAeC;QACtC,OAAOE;IACT,GACA;QAACH;KAAe;IAGlB,gHAAgH;IAChH,MAAMiB,sBAAsBjC,YAC1B,eAAekC,UAA2CjB,QAA4B;QACpF,MAAM,EAAEe,KAAI,EAAE,GAAGf;QACjB,MAAM,CAAC,EAAEE,KAAI,EAAEI,SAAQ,EAAE,EAAEY,OAAO,GAAG,MAAMC,QAAQC,IAAI;YAACrB,eAAeC;YAAWH,UAAU,cAAckB;SAAM;QAEhH,0BAA0B;QAC1B,MAAMM,SAASH,OAAOI,aAAapB,KAAKgB,OAAOhB,MAAM;YAAEI;QAAS;QAChE,IAAIb,aAAaY,WAAW;YAC1B,OAAOZ,SAAS4B;QAClB;QACA,OAAOA;IACT,GACA;QAACtB;QAAgBF;QAAWJ;KAAS;IAGvC,MAAM8B,4BAA4BtC,SAChC,OAAOuC;QACL,MAAM,CAACC,gBAAgBxB,aAAayB,kBAAkB,GAAG,MAAMP,QAAQC,IAAI;YACzEtB,mBAAmB;YACnBH,UAAUH,cAAcmC,gBAAgBhC,SAAS6B,wBAAwB,EAAE;YAC3EhC,cAAcoC,sBAAsBJ;SACrC;QAED,gHAAgH;QAChH,MAAMK,2BAA2BJ,eAAeK,KAAK,CAAClC,WAAaA,SAASmB,SAASS;QACrF,IAAIK,6BAA6BxB,WAAW;YAC1C,MAAM,IAAIS,MAAM,CAAC,8CAA8C,EAAEU,qBAAqB,CAAC,CAAC;QAC1F;QAEA,4CAA4C;QAC5C,MAAM,EAAEO,QAAO,EAAEC,QAAO,EAAE,GAAGC,gCAAgCJ,yBAAyBK,QAAQzB;QAE9F,+DAA+D;QAC/D,IAAInB,8BAAAA,+BAAAA,KAAAA,IAAAA,kBAAmBY,KAAKD,aAAa;YACvC,IAAK,MAAMkC,gBAAgB7C,kBAAkBY,KAAKD,YAAa;gBAC7D,MAAMC,OAAOZ,kBAAkBY,KAAKD,WAAW,CAACkC,aAAa;gBAC7D,IAAIjC,SAASG,aAAaH,KAAKgB,OAAOH,SAASS,sBAAsB;gBAErEQ,QAAQ9B,MAAMiC,cAAc;YAC9B;QACF;QAEA,wCAAwC;QACxC,KAAK,MAAMzB,cAAcT,YAAa;YACpC,MAAMkC,eAAezB,WAAWd,SAASa;YACzCuB,QAAQtB,WAAWR,MAAMiC,cAAc,WAAW,CAAC,UAAU,EAAExC,QAAQ,YAAY,CAAC;QACtF;QAEA,iCAAiC;QACjC,KAAK,MAAMiB,oBAAoBc,kBAAmB;YAChD,MAAMS,eAAevB,iBAAiBhB,SAASa;YAC/CuB,QAAQpB,iBAAiBV,MAAMiC,cAAc,UAAU;QACzD;QAEA,OAAOJ;IACT;IAGF,MAAMK,WAA4BpD,QAChC,IAAO,CAAA;YACL2B;YACAK;YACAO;QACF,CAAA,GACA;QAACZ;QAAeK;QAAqBO;KAA0B;IAGjE,qBAAO,KAACrC,uBAAuBmD;QAASC,OAAOF;kBAAW1C;;AAC5D;AAEA,SAASa,wBAAwBgC,GAAkB,EAAEC,MAAqC;IACxF,OAAOD,IAAIE,gBAAgBF,IAAIE,cAAcD,UAAU;AACzD;AAEA,uEAAuE;AACvE,SAASpC,wBACPsC,oBAAkD,EAClD1C,QAA4B;IAE5B,IAAI0C,yBAAyBrC,WAAW,OAAOA;IAE/C,qCAAqC;IACrC,IAAIL,SAASS,SAASJ,WAAW;QAC/B,MAAMsC,QAAQD,oBAAoB,CAAC1C,SAASS,KAAK;QACjD,IAAIkC,UAAUtC,WAAW,OAAOA;QAChC,OAAOsC,MAAMzB,OAAOH,SAASf,SAASe,OAAO;YAAEN,MAAMT,SAASS;YAAMP,MAAMyC;QAAM,IAAItC;IACtF;IAEA,2EAA2E;IAC3E,MAAMuC,SAASC,OAAOC,QAAQJ,sBAAsBZ,KAClD,CAACiB,QAAUA,KAAK,CAAC,EAAE,CAAC7B,OAAOH,SAASf,SAASe,QAAQgC,KAAK,CAAC,EAAE,CAACC;IAEhE,IAAI,CAACJ,QAAQ;QACX,OAAOvC;IACT;IACA,OAAO;QAAEI,MAAMmC,MAAM,CAAC,EAAE;QAAE1C,MAAM0C,MAAM,CAAC,EAAE;IAAC;AAC5C;AASA;;;CAGC,GACD,SAASX,gCAAgCgB,iBAAyB;IAIhE,MAAMlB,UAAuC,EAAE;IAC/C,MAAMmB,YAAY,IAAIC;IACtB,IAAIC,UAAU;IACd,IAAIC,uBAAuB;IAC3B,MAAMC,eAAuC,CAAC;IAC9C,IAAIC,oBAAoB,GAAG,+EAA+E;IAE1G,MAAMvB,UAAU,CAAC9B,MAAsBiC,cAAsBqB,OAAgBC;YAuBnEvD;QAtBRsD,QAAQA,kBAAAA,mBAAAA,QAAS;QAEjB,0EAA0E;QAC1E,IAAIJ,SAAS;YACXrB,QAAQ2B,KAAK;gBACXF,OAAO,CAAC,QAAQ,EAAEP,kBAAkB,CAAC;gBACrCU,OAAO,EAAE;YACX;QACF;YAG8BL;QAD9B,gCAAgC;QAChC,IAAIM,kBAAkB7B,OAAO,CAACuB,CAAAA,sBAAAA,YAAY,CAACE,MAAM,cAAnBF,iCAAAA,sBAAuB,CAAC,EAAE;QACxD,IAAI,CAACM,iBAAiB;YACpBN,YAAY,CAACE,MAAM,GAAGD;YACtBK,kBAAkB;gBAAED,OAAO,EAAE;gBAAEH;gBAAOC;YAAS;YAC/C1B,OAAO,CAACwB,kBAAkB,GAAGK;YAC7BL;QACF;QAEA,wBAAwB;QACxB,MAAMM,eAAeX,UAAUY,IAAI3B;YAE3BjC;QADR0D,gBAAgBD,MAAMD,KAAK;YACzBjD,MAAMP,CAAAA,qBAAAA,CAAAA,gBAAAA,KAAKgC,qBAALhC,2BAAAA,KAAAA,IAAAA,cAAcO,kBAAdP,gCAAAA,qBAAsBiC;YAC5B4B,YAAYF;YACZ7D,UAAU;gBACRe,MAAMb,KAAKgB,OAAOH;gBAClBN,MAAM0B;gBACNqB;YACF;QACF;QACAN,UAAUc,IAAI7B;QAEd,MAAM8B,oBAAoB,CAACJ,gBAAgB3D,KAAK8C,WAAW,CAACK;QAC5D,IAAItB,OAAO,CAAC,EAAE,IAAKqB,CAAAA,WAAWa,iBAAgB,GAAI;YAChD,8GAA8G;YAC9GlC,OAAO,CAAC,EAAE,CAAC4B,QAAQ;gBACjB;oBACElD,MAAM,CAAC,SAAS,EAAE0B,aAAa,MAAM,EAAEqB,MAAM,CAAC,CAAC;oBAC/CxD,UAAU;wBACRe,MAAMb,KAAKgB,OAAOH;oBACpB;gBACF;aACD;YACD,kGAAkG;YAClG,wGAAwG;YACxG,gDAAgD;YAChDsC,uBAAuBY;QACzB;QAEA,qEAAqE;QACrE,IAAIJ,cAAc;YAChB,IAAK,IAAIK,IAAIb,uBAAuB,IAAI,GAAGa,IAAIX,mBAAmBW,IAAK;oBACpEnC;oBAAAA;gBAAAA,CAAAA,CAAAA,mBAAAA,CAAAA,aAAAA,OAAO,CAACmC,EAAE,cAAVnC,wBAAAA,KAAAA,IAAAA,WAAY4B,mBAAZ5B,8BAAAA,mBAAqB,EAAE,AAAD,EACpBoC,OAAO,CAACC,OAA+BA,KAAKpE,SAASS,SAAS0B,cAC9DkC,QAAQ,CAACD;oBACRA,KAAKE,aAAa;gBACpB;YACJ;QACF;QAEAlB,UAAU;IACZ;IAEA,OAAO;QAAErB;QAASC;IAAQ;AAC5B"}

package/dist/context/TemplateVariableProvider/TemplateVariableProvider.d.ts

@@ -1,12 +1,13 @@
-/// <reference types="react" />
-import { VariableStateMap, VariableState, VariableOption } from '@perses-dev/plugin-system';
-import { VariableName, VariableValue, VariableDefinition } from '@perses-dev/core';
+import { ReactNode } from 'react';
+import { VariableStateMap, VariableState, VariableStoreStateMap, VariableOption } from '@perses-dev/plugin-system';
+import { VariableName, VariableValue, VariableDefinition, BuiltinVariableDefinition } from '@perses-dev/core';
 declare type TemplateVariableStore = {
     variableDefinitions: VariableDefinition[];
-    variableState: VariableStateMap;
-    setVariableValue: (variableName: VariableName, value: VariableValue) => void;
-    setVariableOptions: (name: VariableName, options: VariableOption[]) => void;
-    setVariableLoading: (name: VariableName, loading: boolean) => void;
+    externalVariableDefinitions: ExternalVariableDefinition[];
+    variableState: VariableStoreStateMap;
+    setVariableValue: (variableName: VariableName, value: VariableValue, source?: string) => void;
+    setVariableOptions: (name: VariableName, options: VariableOption[], source?: string) => void;
+    setVariableLoading: (name: VariableName, loading: boolean, source?: string) => void;
     setVariableDefinitions: (definitions: VariableDefinition[]) => void;
     setVariableDefaultValues: () => VariableDefinition[];
     getSavedVariablesStatus: () => {
@@ -14,15 +15,29 @@ declare type TemplateVariableStore = {
         modifiedVariableNames: string[];
     };
 };
+export declare function useTemplateVariableStoreCtx(): Omit<Omit<import("zustand").StoreApi<TemplateVariableStore>, "setState"> & {
+    setState<A extends string | {
+        type: unknown;
+    }>(partial: TemplateVariableStore | Partial<TemplateVariableStore> | ((state: TemplateVariableStore) => TemplateVariableStore | Partial<TemplateVariableStore>), replace?: boolean | undefined, action?: A | undefined): void;
+}, "setState"> & {
+    setState(nextStateOrUpdater: TemplateVariableStore | Partial<TemplateVariableStore> | ((state: import("immer/dist/internal").WritableDraft<TemplateVariableStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
+        type: unknown;
+    } | undefined): void;
+};
 export declare function useTemplateVariableValues(variableNames?: string[]): VariableStateMap;
-export declare function useTemplateVariable(name: string): {
+/**
+ * Get the state and definition of a variable from the Template variables context.
+ * @param name name of the variable
+ * @param source if given, it searches in the external variables
+ */
+export declare function useTemplateVariable(name: string, source?: string): {
     state: VariableState | undefined;
     definition: VariableDefinition | undefined;
 };
 export declare function useTemplateVariableActions(): {
-    setVariableValue: (variableName: string, value: VariableValue) => void;
-    setVariableLoading: (name: string, loading: boolean) => void;
-    setVariableOptions: (name: string, options: VariableOption[]) => void;
+    setVariableValue: (variableName: string, value: VariableValue, source?: string | undefined) => void;
+    setVariableLoading: (name: string, loading: boolean, source?: string | undefined) => void;
+    setVariableOptions: (name: string, options: VariableOption[], source?: string | undefined) => void;
     setVariableDefinitions: (definitions: VariableDefinition[]) => void;
     setVariableDefaultValues: () => VariableDefinition[];
     getSavedVariablesStatus: () => {
@@ -31,11 +46,31 @@ export declare function useTemplateVariableActions(): {
     };
 };
 export declare function useTemplateVariableDefinitions(): VariableDefinition[];
+export declare function useTemplateExternalVariableDefinitions(): ExternalVariableDefinition[];
 export declare function useTemplateVariableStore(): TemplateVariableStore;
+export declare type ExternalVariableDefinition = {
+    source: string;
+    tooltip?: {
+        title?: string;
+        description?: string;
+    };
+    editLink?: string;
+    definitions: VariableDefinition[];
+};
 export interface TemplateVariableProviderProps {
-    children: React.ReactNode;
+    children: ReactNode;
     initialVariableDefinitions?: VariableDefinition[];
+    /**
+     * 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.
+     */
+    externalVariableDefinitions?: ExternalVariableDefinition[];
+    builtinVariables?: BuiltinVariableDefinition[];
 }
-export declare function TemplateVariableProvider({ children, initialVariableDefinitions }: TemplateVariableProviderProps): JSX.Element;
+export declare function TemplateVariableProvider({ children, initialVariableDefinitions, externalVariableDefinitions, builtinVariables, }: TemplateVariableProviderProps): JSX.Element;
 export {};
 //# sourceMappingURL=TemplateVariableProvider.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"TemplateVariableProvider.d.ts","sourceRoot":"","sources":["../../../src/context/TemplateVariableProvider/TemplateVariableProvider.tsx"],"names":[],"mappings":";AAkBA,OAAO,EAA2B,gBAAgB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACrH,OAAO,EAAkC,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAKnH,aAAK,qBAAqB,GAAG;IAC3B,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C,aAAa,EAAE,gBAAgB,CAAC;IAChC,gBAAgB,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;IAC7E,kBAAkB,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,KAAK,IAAI,CAAC;IAC5E,kBAAkB,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACnE,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;AAaF,wBAAgB,yBAAyB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,oBAqBjE;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM;;;EAU/C;AAED,wBAAgB,0BAA0B;;;;;;;;;;EAYzC;AAED,wBAAgB,8BAA8B,yBAG7C;AAED,wBAAgB,wBAAwB,0BAGvC;AA0JD,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,0BAA0B,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACnD;AAED,wBAAgB,wBAAwB,CAAC,EAAE,QAAQ,EAAE,0BAA+B,EAAE,EAAE,6BAA6B,eASpH"}
+{"version":3,"file":"TemplateVariableProvider.d.ts","sourceRoot":"","sources":["../../../src/context/TemplateVariableProvider/TemplateVariableProvider.tsx"],"names":[],"mappings":"AAaA,OAAO,EAAiB,SAAS,EAAiC,MAAM,OAAO,CAAC;AAKhF,OAAO,EAEL,gBAAgB,EAChB,aAAa,EACb,qBAAqB,EACrB,cAAc,EAGf,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAEL,YAAY,EACZ,aAAa,EACb,kBAAkB,EAGlB,yBAAyB,EAC1B,MAAM,kBAAkB,CAAC;AAK1B,aAAK,qBAAqB,GAAG;IAC3B,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C,2BAA2B,EAAE,0BAA0B,EAAE,CAAC;IAC1D,aAAa,EAAE,qBAAqB,CAAC;IACrC,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,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;AAKF,wBAAgB,2BAA2B;;;;;;;;EAM1C;AAED,wBAAgB,yBAAyB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,oBAoCjE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;;;EAWhE;AAED,wBAAgB,0BAA0B;;;;;;;;;;EAYzC;AAED,wBAAgB,8BAA8B,yBAG7C;AAED,wBAAgB,sCAAsC,iCAGrD;AAED,wBAAgB,wBAAwB,0BAGvC;AAyPD,oBAAY,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,6BAA6B;IAC5C,QAAQ,EAAE,SAAS,CAAC;IACpB,0BAA0B,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAClD;;;;;;;OAOG;IACH,2BAA2B,CAAC,EAAE,0BAA0B,EAAE,CAAC;IAC3D,gBAAgB,CAAC,EAAE,yBAAyB,EAAE,CAAC;CAChD;AAED,wBAAgB,wBAAwB,CAAC,EACvC,QAAQ,EACR,0BAA+B,EAC/B,2BAAgC,EAChC,gBAAqB,GACtB,EAAE,6BAA6B,eAY/B"}