@perses-dev/dashboards 0.46.0 → 0.47.0-rc0

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 { DashboardResource, DatasourceResource, DatasourceSelector, DatasourceSpec, GlobalDatasourceResource, EphemeralDashboardResource } from '@perses-dev/core';
 import { DatasourceClient } from '@perses-dev/plugin-system';
 export interface DatasourceStoreProviderProps {
     dashboardResource?: DashboardResource | EphemeralDashboardResource;
@@ -20,10 +20,10 @@ 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.

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,SAAS,EAAkC,MAAM,OAAO,CAAC;AAClE,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;IAE5C,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,KAAK,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;IAE1G,mBAAmB,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC,CAAC;IAErG,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAEzF,qBAAqB,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC;CACrF;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,4BAA4B,2CAyL1E"}

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;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,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 { 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\n  getDatasource: (project: string, selector: DatasourceSelector) => Promise<DatasourceResource | undefined>;\n\n  getGlobalDatasource: (selector: DatasourceSelector) => Promise<GlobalDatasourceResource | undefined>;\n\n  listDatasources: (project: string, pluginKind?: string) => Promise<DatasourceResource[]>;\n\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) {\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;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,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"}

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

@@ -0,0 +1,126 @@
+import { ReactNode } from 'react';
+import { VariableStateMap, VariableState, VariableStoreStateMap, VariableOption } from '@perses-dev/plugin-system';
+import { VariableName, VariableValue, VariableDefinition, BuiltinVariableDefinition } 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(): Omit<Omit<import("zustand").StoreApi<VariableDefinitionStore>, "setState"> & {
+    setState<A extends string | {
+        type: string;
+    }>(partial: VariableDefinitionStore | Partial<VariableDefinitionStore> | ((state: VariableDefinitionStore) => VariableDefinitionStore | Partial<VariableDefinitionStore>), replace?: boolean | undefined, action?: A | undefined): void;
+}, "setState"> & {
+    setState(nextStateOrUpdater: VariableDefinitionStore | Partial<VariableDefinitionStore> | ((state: import("immer/dist/internal").WritableDraft<VariableDefinitionStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
+        type: string;
+    } | undefined): void;
+};
+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): {
+    state: VariableState | undefined;
+    definition: VariableDefinition | undefined;
+};
+export declare function useVariableDefinitionActions(): {
+    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: () => {
+        isSavedVariableModified: boolean;
+        modifiedVariableNames: string[];
+    };
+};
+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): import("react/jsx-runtime").JSX.Element;
+export declare function VariableProviderWithQueryParams({ children, initialVariableDefinitions, externalVariableDefinitions, builtinVariableDefinitions: builtinVariables, }: VariableProviderProps): import("react/jsx-runtime").JSX.Element;
+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,SAAS,EAAiC,MAAM,OAAO,CAAC;AAMhF,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;;;;;;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;AAQF,wBAAgB,6BAA6B;;;;;;;;EAM5C;AAED,wBAAgB,2BAA2B,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAoCtF;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;;;EAW1E;AAED,wBAAgB,4BAA4B;;;;;;;;;;EAY3C;AAED,wBAAgB,sBAAsB,yBAGrC;AAED,wBAAgB,8BAA8B,iCAG7C;AA4PD;;;;;;;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,2CAQvB;AAED,wBAAgB,+BAA+B,CAAC,EAC9C,QAAQ,EACR,0BAA+B,EAC/B,2BAAgC,EAChC,0BAA0B,EAAE,gBAAqB,GAClD,EAAE,qBAAqB,2CAYvB"}

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
@@ -17,23 +17,25 @@ 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();
+export function useVariableDefinitionStates(variableNames) {
+    const store = useVariableDefinitionStoreCtx();
     return useStoreWithEqualityFn(store, (s)=>{
-        const vars = {};
+        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);
         names.forEach((name)=>{
@@ -43,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)=>{
@@ -57,20 +59,20 @@ 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({
@@ -85,8 +87,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,
@@ -98,22 +100,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 = {};
@@ -221,7 +219,7 @@ function PluginProvider({ children, builtinVariables }) {
         value: {
             variables: allBuiltinVariables
         },
-        children: /*#__PURE__*/ _jsx(TemplateVariableContext.Provider, {
+        children: /*#__PURE__*/ _jsx(VariableContext.Provider, {
             value: {
                 state: values
             },
@@ -229,16 +227,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
                 );
             },
@@ -336,28 +334,29 @@ function createTemplateVariableSrvStore({ initialVariableDefinitions = [], exter
         }))));
     return store;
 }
-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,
@@ -366,4 +365,4 @@ export function TemplateVariableProviderWithQueryParams({ children, initialVaria
     });
 }
 
-//# sourceMappingURL=TemplateVariableProvider.js.map
+//# sourceMappingURL=VariableProvider.js.map

package/dist/context/VariableProvider/VariableProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/context/VariableProvider/VariableProvider.tsx"],"sourcesContent":["// Copyright 2024 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { createContext, ReactNode, useContext, useMemo, useState } from 'react';\nimport { createStore, useStore } from 'zustand';\nimport { useStoreWithEqualityFn } from 'zustand/traditional';\nimport { immer } from 'zustand/middleware/immer';\nimport { devtools } from 'zustand/middleware';\nimport produce from 'immer';\nimport {\n  VariableContext,\n  VariableStateMap,\n  VariableState,\n  VariableStoreStateMap,\n  VariableOption,\n  BuiltinVariableContext,\n  useTimeRange,\n} from '@perses-dev/plugin-system';\nimport {\n  DEFAULT_ALL_VALUE as ALL_VALUE,\n  VariableName,\n  VariableValue,\n  VariableDefinition,\n  formatDuration,\n  intervalToPrometheusDuration,\n  BuiltinVariableDefinition,\n} from '@perses-dev/core';\nimport { checkSavedDefaultVariableStatus, findVariableDefinitionByName, mergeVariableDefinitions } from './utils';\nimport { hydrateVariableDefinitionStates as hydrateVariableDefinitionStates } from './hydrationUtils';\nimport { getInitalValuesFromQueryParameters, getURLQueryParamName, useVariableQueryParams } from './query-params';\n\n/**\n * This store is used to manipulate and read the definition of the variables and their state.\n * - being local or external variables.\n * - being text or list variables.\n * - being of any state (value, options, loading, error, ...) check {@VariableState}\n * Go and read each property documentation for more details.\n */\ntype VariableDefinitionStore = {\n  /**\n   * List of local variables definitions.\n   * This is typically the variable definition that can be modified through the setVariableDefinition setter.\n   *\n   * In Perses App ecosystem, this is typically the dashboard scope variables, that's why we call them local.\n   * Note that depending on the form, we can reuse this store to modify higher scope variables. For example,\n   * when we modify the variable of a project, we'll set this field with project scope variables. To be able to modify\n   * them.\n   */\n  variableDefinitions: VariableDefinition[];\n  /**\n   * List of external variable definitions.\n   * This is static variable definitions that won´t be modified under this context.\n   * You'll have to set one list of external variable definition by scope. See {@link ExternalVariableDefinition} for\n   * more details.\n   *\n   * In Perses App ecosystem, this is typically the project or global scope variables.\n   * Note that depending on the form, we can reuse this store to modify higher scope variables. For example,\n   * when we modify the variable of a project, we'll set this field with global scope variables. Which means we\n   * won't be able to modify them from this form.\n   */\n  externalVariableDefinitions: ExternalVariableDefinition[];\n  /**\n   * Additionally to definitions, we need to associate to each variable a state. That's what this map is meant for.\n   * This can be heavily modified under this context, using the different setters available.\n   * Note that the state of local AND external variables can be modified.\n   */\n  variableState: VariableStoreStateMap;\n  /**\n   * Allow to modify the `value` property of a variable in the state map.\n   * @param variableName identify the variable\n   * @param value new value\n   * @param source identify the variable source if this is an external variable. See {@link ExternalVariableDefinition}\n   */\n  setVariableValue: (variableName: VariableName, value: VariableValue, source?: string) => void;\n  /**\n   * Allow to modify the `options` property of a variable in the state map.\n   * @param variableName identify the variable\n   * @param options new value\n   * @param source identify the variable source if this is an external variable. See {@link ExternalVariableDefinition}\n   */\n  setVariableOptions: (name: VariableName, options: VariableOption[], source?: string) => void;\n  /**\n   * Allow to modify the `loading` property of a variable in the state map.\n   * @param variableName identify the variable\n   * @param laoding new value\n   * @param source identify the variable source if this is an external variable. See {@link ExternalVariableDefinition}\n   */\n  setVariableLoading: (name: VariableName, loading: boolean, source?: string) => void;\n  setVariableDefinitions: (definitions: VariableDefinition[]) => void;\n  setVariableDefaultValues: () => VariableDefinition[];\n  getSavedVariablesStatus: () => { isSavedVariableModified: boolean; modifiedVariableNames: string[] };\n};\n\n/**\n * Context object for {@link VariableDefinitionStore}.\n */\nconst VariableDefinitionStoreContext = createContext<ReturnType<typeof createVariableDefinitionStore> | undefined>(\n  undefined\n);\nexport function useVariableDefinitionStoreCtx() {\n  const context = useContext(VariableDefinitionStoreContext);\n  if (!context) {\n    throw new Error('VariableStoreContext not initialized');\n  }\n  return context;\n}\n\nexport function useVariableDefinitionStates(variableNames?: string[]): VariableStateMap {\n  const store = useVariableDefinitionStoreCtx();\n  return useStoreWithEqualityFn(\n    store,\n    (s) => {\n      const varStates: VariableStateMap = {};\n\n      // Collect values of local variables, from the variable state\n      const names = variableNames ?? s.variableDefinitions.map((value) => value.spec.name);\n      names.forEach((name) => {\n        const varState = s.variableState.get({ name });\n        if (!varState || varState.overridden) {\n          return;\n        }\n        varStates[name] = varState;\n      });\n\n      // Collect values of external variables, from the variable state\n      s.externalVariableDefinitions.forEach((d) => {\n        const source = d.source;\n        d.definitions.forEach((value) => {\n          const name = value.spec.name;\n          const varState = s.variableState.get({ name, source });\n          if (!varState || varState.overridden) {\n            return;\n          }\n          varStates[name] = varState;\n        });\n      });\n\n      return varStates;\n    },\n    (left, right) => {\n      return JSON.stringify(left) === JSON.stringify(right);\n    }\n  );\n}\n\n/**\n * Get the state and definition of a variable from the variables context.\n * @param name name of the variable\n * @param source if given, it searches in the external variables\n */\nexport function useVariableDefinitionAndState(name: string, source?: string) {\n  const store = useVariableDefinitionStoreCtx();\n  return useStore(store, (s) => {\n    const state = s.variableState.get({ name, source });\n    const definitions = source\n      ? s.externalVariableDefinitions.find((v) => v.source === source)?.definitions\n      : s.variableDefinitions;\n    const definition = (definitions || []).find((v) => v.spec.name === name);\n\n    return { state, definition };\n  });\n}\n\nexport function useVariableDefinitionActions() {\n  const store = useVariableDefinitionStoreCtx();\n  return useStore(store, (s) => {\n    return {\n      setVariableValue: s.setVariableValue,\n      setVariableLoading: s.setVariableLoading,\n      setVariableOptions: s.setVariableOptions,\n      setVariableDefinitions: s.setVariableDefinitions,\n      setVariableDefaultValues: s.setVariableDefaultValues,\n      getSavedVariablesStatus: s.getSavedVariablesStatus,\n    };\n  });\n}\n\nexport function useVariableDefinitions() {\n  const store = useVariableDefinitionStoreCtx();\n  return useStore(store, (s) => s.variableDefinitions);\n}\n\nexport function useExternalVariableDefinitions() {\n  const store = useVariableDefinitionStoreCtx();\n  return useStore(store, (s) => s.externalVariableDefinitions);\n}\n\ninterface PluginProviderProps {\n  children: ReactNode;\n  builtinVariables?: BuiltinVariableDefinition[];\n}\n\nfunction PluginProvider({ children, builtinVariables }: PluginProviderProps) {\n  const originalValues = useVariableDefinitionStates();\n  const definitions = useVariableDefinitions();\n  const externalDefinitions = useExternalVariableDefinitions();\n  const { absoluteTimeRange } = useTimeRange();\n\n  const values = useMemo(() => {\n    const contextValues: VariableStateMap = {};\n\n    // This will loop through all the current variables values\n    // and update any variables that have ALL_VALUE as their current value\n    // to include all options.\n    Object.keys(originalValues).forEach((name) => {\n      const v = { ...originalValues[name] } as VariableState;\n\n      if (v.value === ALL_VALUE) {\n        const definition = findVariableDefinitionByName(name, definitions, externalDefinitions);\n        // If the variable is a list variable and has a custom all value, then use that value instead\n        if (definition?.kind === 'ListVariable' && definition.spec.customAllValue) {\n          v.value = definition.spec.customAllValue;\n        } else {\n          v.value = v.options?.map((o: { value: string }) => o.value) ?? null;\n        }\n      }\n      contextValues[name] = v;\n    });\n    return contextValues;\n  }, [originalValues, definitions, externalDefinitions]);\n\n  const allBuiltinVariables: BuiltinVariableDefinition[] = useMemo(() => {\n    const result: BuiltinVariableDefinition[] = [\n      {\n        kind: 'BuiltinVariable',\n        spec: {\n          name: '__from',\n          value: () => absoluteTimeRange.start.valueOf().toString(),\n          source: 'Dashboard',\n          display: {\n            name: '__from',\n            description: 'Start time of the current time range in unix millisecond epoch',\n            hidden: true,\n          },\n        },\n      },\n      {\n        kind: 'BuiltinVariable',\n        spec: {\n          name: '__to',\n          value: () => absoluteTimeRange.end.valueOf().toString(),\n          source: 'Dashboard',\n          display: {\n            name: '__to',\n            description: 'End time of the current time range in unix millisecond epoch',\n            hidden: true,\n          },\n        },\n      },\n      {\n        kind: 'BuiltinVariable',\n        spec: {\n          name: '__range',\n          value: () => formatDuration(intervalToPrometheusDuration(absoluteTimeRange)),\n          source: 'Dashboard',\n          display: {\n            name: '__range',\n            description: 'The range for the current dashboard in human readable format',\n            hidden: true,\n          },\n        },\n      },\n      {\n        kind: 'BuiltinVariable',\n        spec: {\n          name: '__range_s',\n          value: () => ((absoluteTimeRange.end.valueOf() - absoluteTimeRange.start.valueOf()) / 1000).toString(),\n          source: 'Dashboard',\n          display: {\n            name: '__range_s',\n            description: 'The range for the current dashboard in second',\n            hidden: true,\n          },\n        },\n      },\n      {\n        kind: 'BuiltinVariable',\n        spec: {\n          name: '__range_ms',\n          value: () => (absoluteTimeRange.end.valueOf() - absoluteTimeRange.start.valueOf()).toString(),\n          source: 'Dashboard',\n          display: {\n            name: '__range_ms',\n            description: 'The range for the current dashboard in millisecond',\n            hidden: true,\n          },\n        },\n      },\n    ];\n    builtinVariables?.forEach((def) => result.push(def));\n    return result;\n  }, [absoluteTimeRange, builtinVariables]);\n\n  return (\n    <BuiltinVariableContext.Provider value={{ variables: allBuiltinVariables }}>\n      <VariableContext.Provider value={{ state: values }}>{children}</VariableContext.Provider>\n    </BuiltinVariableContext.Provider>\n  );\n}\n\ninterface VariableDefinitionStoreArgs {\n  initialVariableDefinitions?: VariableDefinition[];\n  externalVariableDefinitions?: ExternalVariableDefinition[];\n  queryParams?: ReturnType<typeof useVariableQueryParams>;\n}\n\nfunction createVariableDefinitionStore({\n  initialVariableDefinitions = [],\n  externalVariableDefinitions = [],\n  queryParams,\n}: VariableDefinitionStoreArgs) {\n  const initialParams = getInitalValuesFromQueryParameters(queryParams ? queryParams[0] : {});\n  const store = createStore<VariableDefinitionStore>()(\n    devtools(\n      immer((set, get) => ({\n        variableState: hydrateVariableDefinitionStates(\n          initialVariableDefinitions,\n          initialParams,\n          externalVariableDefinitions\n        ),\n        variableDefinitions: initialVariableDefinitions,\n        externalVariableDefinitions: externalVariableDefinitions,\n        setVariableDefinitions(definitions: VariableDefinition[]) {\n          set(\n            (state) => {\n              state.variableDefinitions = definitions;\n              state.variableState = hydrateVariableDefinitionStates(\n                definitions,\n                initialParams,\n                externalVariableDefinitions\n              );\n            },\n            false,\n            '[Variables] setVariableDefinitions' // Used for action name in Redux devtools\n          );\n        },\n        setVariableOptions(name, options, source?: string) {\n          set(\n            (state) => {\n              const varState = state.variableState.get({ name, source });\n              if (!varState) {\n                return;\n              }\n              varState.options = options;\n            },\n            false,\n            '[Variables] setVariableOptions'\n          );\n        },\n        setVariableLoading(name, loading, source?: string) {\n          set(\n            (state) => {\n              const varState = state.variableState.get({ name, source });\n              if (!varState) {\n                return;\n              }\n              varState.loading = loading;\n            },\n            false,\n            '[Variables] setVariableLoading'\n          );\n        },\n        setVariableValue: (name, value, source?: string) =>\n          set(\n            (state) => {\n              let val = value;\n              const varState = state.variableState.get({ name, source });\n              if (!varState) {\n                return;\n              }\n\n              // Make sure there is only one all value\n              if (Array.isArray(val) && val.includes(ALL_VALUE)) {\n                if (val.at(-1) === ALL_VALUE) {\n                  val = ALL_VALUE;\n                } else {\n                  val = val.filter((v) => v !== ALL_VALUE);\n                }\n              }\n              if (queryParams) {\n                const setQueryParams = queryParams[1];\n                setQueryParams({ [getURLQueryParamName(name)]: val });\n              }\n              varState.value = val;\n            },\n            false,\n            '[Variables] setVariableValue'\n          ),\n        setVariableDefaultValues: () => {\n          const variableDefinitions = get().variableDefinitions;\n          const variableState = get().variableState;\n          const updatedVariables = produce(variableDefinitions, (draft) => {\n            draft.forEach((variable, index) => {\n              const name = variable.spec.name;\n              if (variable.kind === 'ListVariable') {\n                const currentVariable = variableState.get({ name });\n                if (currentVariable?.value !== undefined) {\n                  draft[index] = {\n                    kind: 'ListVariable',\n                    spec: produce(variable.spec, (specDraft) => {\n                      specDraft.defaultValue = currentVariable.value;\n                    }),\n                  };\n                }\n              } else if (variable.kind === 'TextVariable') {\n                const currentVariable = variableState.get({ name });\n                const currentVariableValue = typeof currentVariable?.value === 'string' ? currentVariable.value : '';\n                if (currentVariable?.value !== undefined) {\n                  draft[index] = {\n                    kind: 'TextVariable',\n                    spec: produce(variable.spec, (specDraft) => {\n                      specDraft.value = currentVariableValue;\n                    }),\n                  };\n                }\n              }\n            });\n          });\n          set(\n            (state) => {\n              state.variableDefinitions = updatedVariables;\n            },\n            false,\n            '[Variables] setVariableDefaultValues'\n          );\n          return updatedVariables;\n        },\n        getSavedVariablesStatus: () => {\n          return checkSavedDefaultVariableStatus(get().variableDefinitions, get().variableState);\n        },\n      }))\n    )\n  );\n\n  return store;\n}\n\n/**\n * The external variables allow you to give to the provider some additional variables, not defined in the dashboard and static.\n * 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\n * to modify their runtime value as any other variable.\n * If one of the external variable has the same name as a local one, it will be marked as overridden.\n * You can define one list of variable definition by source and as many source as you want.\n * The order of the sources is important as first one will take precedence on the following ones, in case they have same names.\n */\nexport type ExternalVariableDefinition = {\n  source: string;\n  tooltip?: {\n    title?: string;\n    description?: string;\n  };\n  editLink?: string;\n  definitions: VariableDefinition[];\n};\n\nexport interface VariableProviderProps {\n  children: ReactNode;\n  initialVariableDefinitions?: VariableDefinition[];\n  externalVariableDefinitions?: ExternalVariableDefinition[];\n  builtinVariableDefinitions?: BuiltinVariableDefinition[];\n}\n\n// TODO: merge the different providers related to Variables under a single one (and keep \"VariableProvider\" as a name)\nexport function VariableProvider({\n  children,\n  initialVariableDefinitions = [],\n  externalVariableDefinitions = [],\n  builtinVariableDefinitions = [],\n}: VariableProviderProps) {\n  const [store] = useState(createVariableDefinitionStore({ initialVariableDefinitions, externalVariableDefinitions }));\n\n  return (\n    <VariableDefinitionStoreContext.Provider value={store}>\n      <PluginProvider builtinVariables={builtinVariableDefinitions}>{children}</PluginProvider>\n    </VariableDefinitionStoreContext.Provider>\n  );\n}\n\nexport function VariableProviderWithQueryParams({\n  children,\n  initialVariableDefinitions = [],\n  externalVariableDefinitions = [],\n  builtinVariableDefinitions: builtinVariables = [],\n}: VariableProviderProps) {\n  const allVariableDefs = mergeVariableDefinitions(initialVariableDefinitions, externalVariableDefinitions);\n  const queryParams = useVariableQueryParams(allVariableDefs);\n  const [store] = useState(\n    createVariableDefinitionStore({ initialVariableDefinitions, externalVariableDefinitions, queryParams })\n  );\n\n  return (\n    <VariableDefinitionStoreContext.Provider value={store}>\n      <PluginProvider builtinVariables={builtinVariables}>{children}</PluginProvider>\n    </VariableDefinitionStoreContext.Provider>\n  );\n}\n"],"names":["createContext","useContext","useMemo","useState","createStore","useStore","useStoreWithEqualityFn","immer","devtools","produce","VariableContext","BuiltinVariableContext","useTimeRange","DEFAULT_ALL_VALUE","ALL_VALUE","formatDuration","intervalToPrometheusDuration","checkSavedDefaultVariableStatus","findVariableDefinitionByName","mergeVariableDefinitions","hydrateVariableDefinitionStates","getInitalValuesFromQueryParameters","getURLQueryParamName","useVariableQueryParams","VariableDefinitionStoreContext","undefined","useVariableDefinitionStoreCtx","context","Error","useVariableDefinitionStates","variableNames","store","s","varStates","names","variableDefinitions","map","value","spec","name","forEach","varState","variableState","get","overridden","externalVariableDefinitions","d","source","definitions","left","right","JSON","stringify","useVariableDefinitionAndState","state","find","v","definition","useVariableDefinitionActions","setVariableValue","setVariableLoading","setVariableOptions","setVariableDefinitions","setVariableDefaultValues","getSavedVariablesStatus","useVariableDefinitions","useExternalVariableDefinitions","PluginProvider","children","builtinVariables","originalValues","externalDefinitions","absoluteTimeRange","values","contextValues","Object","keys","kind","customAllValue","options","o","allBuiltinVariables","result","start","valueOf","toString","display","description","hidden","end","def","push","Provider","variables","createVariableDefinitionStore","initialVariableDefinitions","queryParams","initialParams","set","loading","val","Array","isArray","includes","at","filter","setQueryParams","updatedVariables","draft","variable","index","currentVariable","specDraft","defaultValue","currentVariableValue","VariableProvider","builtinVariableDefinitions","VariableProviderWithQueryParams","allVariableDefs"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;AAEjC,SAASA,aAAa,EAAaC,UAAU,EAAEC,OAAO,EAAEC,QAAQ,QAAQ,QAAQ;AAChF,SAASC,WAAW,EAAEC,QAAQ,QAAQ,UAAU;AAChD,SAASC,sBAAsB,QAAQ,sBAAsB;AAC7D,SAASC,KAAK,QAAQ,2BAA2B;AACjD,SAASC,QAAQ,QAAQ,qBAAqB;AAC9C,OAAOC,aAAa,QAAQ;AAC5B,SACEC,eAAe,EAKfC,sBAAsB,EACtBC,YAAY,QACP,4BAA4B;AACnC,SACEC,qBAAqBC,SAAS,EAI9BC,cAAc,EACdC,4BAA4B,QAEvB,mBAAmB;AAC1B,SAASC,+BAA+B,EAAEC,4BAA4B,EAAEC,wBAAwB,QAAQ,UAAU;AAClH,SAASC,mCAAmCA,+BAA+B,QAAQ,mBAAmB;AACtG,SAASC,kCAAkC,EAAEC,oBAAoB,EAAEC,sBAAsB,QAAQ,iBAAiB;AAgElH;;CAEC,GACD,MAAMC,+CAAiCxB,cACrCyB;AAEF,OAAO,SAASC;IACd,MAAMC,UAAU1B,WAAWuB;IAC3B,IAAI,CAACG,SAAS;QACZ,MAAM,IAAIC,MAAM;IAClB;IACA,OAAOD;AACT;AAEA,OAAO,SAASE,4BAA4BC,aAAwB;IAClE,MAAMC,QAAQL;IACd,OAAOpB,uBACLyB,OACA,CAACC;QACC,MAAMC,YAA8B,CAAC;QAErC,6DAA6D;QAC7D,MAAMC,QAAQJ,0BAAAA,2BAAAA,gBAAiBE,EAAEG,mBAAmB,CAACC,GAAG,CAAC,CAACC,QAAUA,MAAMC,IAAI,CAACC,IAAI;QACnFL,MAAMM,OAAO,CAAC,CAACD;YACb,MAAME,WAAWT,EAAEU,aAAa,CAACC,GAAG,CAAC;gBAAEJ;YAAK;YAC5C,IAAI,CAACE,YAAYA,SAASG,UAAU,EAAE;gBACpC;YACF;YACAX,SAAS,CAACM,KAAK,GAAGE;QACpB;QAEA,gEAAgE;QAChET,EAAEa,2BAA2B,CAACL,OAAO,CAAC,CAACM;YACrC,MAAMC,SAASD,EAAEC,MAAM;YACvBD,EAAEE,WAAW,CAACR,OAAO,CAAC,CAACH;gBACrB,MAAME,OAAOF,MAAMC,IAAI,CAACC,IAAI;gBAC5B,MAAME,WAAWT,EAAEU,aAAa,CAACC,GAAG,CAAC;oBAAEJ;oBAAMQ;gBAAO;gBACpD,IAAI,CAACN,YAAYA,SAASG,UAAU,EAAE;oBACpC;gBACF;gBACAX,SAAS,CAACM,KAAK,GAAGE;YACpB;QACF;QAEA,OAAOR;IACT,GACA,CAACgB,MAAMC;QACL,OAAOC,KAAKC,SAAS,CAACH,UAAUE,KAAKC,SAAS,CAACF;IACjD;AAEJ;AAEA;;;;CAIC,GACD,OAAO,SAASG,8BAA8Bd,IAAY,EAAEQ,MAAe;IACzE,MAAMhB,QAAQL;IACd,OAAOrB,SAAS0B,OAAO,CAACC;YAGlBA;QAFJ,MAAMsB,QAAQtB,EAAEU,aAAa,CAACC,GAAG,CAAC;YAAEJ;YAAMQ;QAAO;QACjD,MAAMC,cAAcD,UAChBf,sCAAAA,EAAEa,2BAA2B,CAACU,IAAI,CAAC,CAACC,IAAMA,EAAET,MAAM,KAAKA,qBAAvDf,0DAAAA,oCAAgEgB,WAAW,GAC3EhB,EAAEG,mBAAmB;QACzB,MAAMsB,aAAa,AAACT,CAAAA,eAAe,EAAE,AAAD,EAAGO,IAAI,CAAC,CAACC,IAAMA,EAAElB,IAAI,CAACC,IAAI,KAAKA;QAEnE,OAAO;YAAEe;YAAOG;QAAW;IAC7B;AACF;AAEA,OAAO,SAASC;IACd,MAAM3B,QAAQL;IACd,OAAOrB,SAAS0B,OAAO,CAACC;QACtB,OAAO;YACL2B,kBAAkB3B,EAAE2B,gBAAgB;YACpCC,oBAAoB5B,EAAE4B,kBAAkB;YACxCC,oBAAoB7B,EAAE6B,kBAAkB;YACxCC,wBAAwB9B,EAAE8B,sBAAsB;YAChDC,0BAA0B/B,EAAE+B,wBAAwB;YACpDC,yBAAyBhC,EAAEgC,uBAAuB;QACpD;IACF;AACF;AAEA,OAAO,SAASC;IACd,MAAMlC,QAAQL;IACd,OAAOrB,SAAS0B,OAAO,CAACC,IAAMA,EAAEG,mBAAmB;AACrD;AAEA,OAAO,SAAS+B;IACd,MAAMnC,QAAQL;IACd,OAAOrB,SAAS0B,OAAO,CAACC,IAAMA,EAAEa,2BAA2B;AAC7D;AAOA,SAASsB,eAAe,EAAEC,QAAQ,EAAEC,gBAAgB,EAAuB;IACzE,MAAMC,iBAAiBzC;IACvB,MAAMmB,cAAciB;IACpB,MAAMM,sBAAsBL;IAC5B,MAAM,EAAEM,iBAAiB,EAAE,GAAG5D;IAE9B,MAAM6D,SAASvE,QAAQ;QACrB,MAAMwE,gBAAkC,CAAC;QAEzC,0DAA0D;QAC1D,sEAAsE;QACtE,0BAA0B;QAC1BC,OAAOC,IAAI,CAACN,gBAAgB9B,OAAO,CAAC,CAACD;YACnC,MAAMiB,IAAI;gBAAE,GAAGc,cAAc,CAAC/B,KAAK;YAAC;YAEpC,IAAIiB,EAAEnB,KAAK,KAAKvB,WAAW;gBACzB,MAAM2C,aAAavC,6BAA6BqB,MAAMS,aAAauB;gBACnE,6FAA6F;gBAC7F,IAAId,CAAAA,uBAAAA,iCAAAA,WAAYoB,IAAI,MAAK,kBAAkBpB,WAAWnB,IAAI,CAACwC,cAAc,EAAE;oBACzEtB,EAAEnB,KAAK,GAAGoB,WAAWnB,IAAI,CAACwC,cAAc;gBAC1C,OAAO;wBACKtB;wBAAAA;oBAAVA,EAAEnB,KAAK,GAAGmB,CAAAA,kBAAAA,aAAAA,EAAEuB,OAAO,cAATvB,iCAAAA,WAAWpB,GAAG,CAAC,CAAC4C,IAAyBA,EAAE3C,KAAK,eAAhDmB,4BAAAA,iBAAqD;gBACjE;YACF;YACAkB,aAAa,CAACnC,KAAK,GAAGiB;QACxB;QACA,OAAOkB;IACT,GAAG;QAACJ;QAAgBtB;QAAauB;KAAoB;IAErD,MAAMU,sBAAmD/E,QAAQ;QAC/D,MAAMgF,SAAsC;YAC1C;gBACEL,MAAM;gBACNvC,MAAM;oBACJC,MAAM;oBACNF,OAAO,IAAMmC,kBAAkBW,KAAK,CAACC,OAAO,GAAGC,QAAQ;oBACvDtC,QAAQ;oBACRuC,SAAS;wBACP/C,MAAM;wBACNgD,aAAa;wBACbC,QAAQ;oBACV;gBACF;YACF;YACA;gBACEX,MAAM;gBACNvC,MAAM;oBACJC,MAAM;oBACNF,OAAO,IAAMmC,kBAAkBiB,GAAG,CAACL,OAAO,GAAGC,QAAQ;oBACrDtC,QAAQ;oBACRuC,SAAS;wBACP/C,MAAM;wBACNgD,aAAa;wBACbC,QAAQ;oBACV;gBACF;YACF;YACA;gBACEX,MAAM;gBACNvC,MAAM;oBACJC,MAAM;oBACNF,OAAO,IAAMtB,eAAeC,6BAA6BwD;oBACzDzB,QAAQ;oBACRuC,SAAS;wBACP/C,MAAM;wBACNgD,aAAa;wBACbC,QAAQ;oBACV;gBACF;YACF;YACA;gBACEX,MAAM;gBACNvC,MAAM;oBACJC,MAAM;oBACNF,OAAO,IAAM,AAAC,CAAA,AAACmC,CAAAA,kBAAkBiB,GAAG,CAACL,OAAO,KAAKZ,kBAAkBW,KAAK,CAACC,OAAO,EAAC,IAAK,IAAG,EAAGC,QAAQ;oBACpGtC,QAAQ;oBACRuC,SAAS;wBACP/C,MAAM;wBACNgD,aAAa;wBACbC,QAAQ;oBACV;gBACF;YACF;YACA;gBACEX,MAAM;gBACNvC,MAAM;oBACJC,MAAM;oBACNF,OAAO,IAAM,AAACmC,CAAAA,kBAAkBiB,GAAG,CAACL,OAAO,KAAKZ,kBAAkBW,KAAK,CAACC,OAAO,EAAC,EAAGC,QAAQ;oBAC3FtC,QAAQ;oBACRuC,SAAS;wBACP/C,MAAM;wBACNgD,aAAa;wBACbC,QAAQ;oBACV;gBACF;YACF;SACD;QACDnB,6BAAAA,uCAAAA,iBAAkB7B,OAAO,CAAC,CAACkD,MAAQR,OAAOS,IAAI,CAACD;QAC/C,OAAOR;IACT,GAAG;QAACV;QAAmBH;KAAiB;IAExC,qBACE,KAAC1D,uBAAuBiF,QAAQ;QAACvD,OAAO;YAAEwD,WAAWZ;QAAoB;kBACvE,cAAA,KAACvE,gBAAgBkF,QAAQ;YAACvD,OAAO;gBAAEiB,OAAOmB;YAAO;sBAAIL;;;AAG3D;AAQA,SAAS0B,8BAA8B,EACrCC,6BAA6B,EAAE,EAC/BlD,8BAA8B,EAAE,EAChCmD,WAAW,EACiB;IAC5B,MAAMC,gBAAgB5E,mCAAmC2E,cAAcA,WAAW,CAAC,EAAE,GAAG,CAAC;IACzF,MAAMjE,QAAQ3B,cACZI,SACED,MAAM,CAAC2F,KAAKvD,MAAS,CAAA;YACnBD,eAAetB,gCACb2E,4BACAE,eACApD;YAEFV,qBAAqB4D;YACrBlD,6BAA6BA;YAC7BiB,wBAAuBd,WAAiC;gBACtDkD,IACE,CAAC5C;oBACCA,MAAMnB,mBAAmB,GAAGa;oBAC5BM,MAAMZ,aAAa,GAAGtB,gCACpB4B,aACAiD,eACApD;gBAEJ,GACA,OACA,qCAAqC,yCAAyC;;YAElF;YACAgB,oBAAmBtB,IAAI,EAAEwC,OAAO,EAAEhC,MAAe;gBAC/CmD,IACE,CAAC5C;oBACC,MAAMb,WAAWa,MAAMZ,aAAa,CAACC,GAAG,CAAC;wBAAEJ;wBAAMQ;oBAAO;oBACxD,IAAI,CAACN,UAAU;wBACb;oBACF;oBACAA,SAASsC,OAAO,GAAGA;gBACrB,GACA,OACA;YAEJ;YACAnB,oBAAmBrB,IAAI,EAAE4D,OAAO,EAAEpD,MAAe;gBAC/CmD,IACE,CAAC5C;oBACC,MAAMb,WAAWa,MAAMZ,aAAa,CAACC,GAAG,CAAC;wBAAEJ;wBAAMQ;oBAAO;oBACxD,IAAI,CAACN,UAAU;wBACb;oBACF;oBACAA,SAAS0D,OAAO,GAAGA;gBACrB,GACA,OACA;YAEJ;YACAxC,kBAAkB,CAACpB,MAAMF,OAAOU,SAC9BmD,IACE,CAAC5C;oBACC,IAAI8C,MAAM/D;oBACV,MAAMI,WAAWa,MAAMZ,aAAa,CAACC,GAAG,CAAC;wBAAEJ;wBAAMQ;oBAAO;oBACxD,IAAI,CAACN,UAAU;wBACb;oBACF;oBAEA,wCAAwC;oBACxC,IAAI4D,MAAMC,OAAO,CAACF,QAAQA,IAAIG,QAAQ,CAACzF,YAAY;wBACjD,IAAIsF,IAAII,EAAE,CAAC,CAAC,OAAO1F,WAAW;4BAC5BsF,MAAMtF;wBACR,OAAO;4BACLsF,MAAMA,IAAIK,MAAM,CAAC,CAACjD,IAAMA,MAAM1C;wBAChC;oBACF;oBACA,IAAIkF,aAAa;wBACf,MAAMU,iBAAiBV,WAAW,CAAC,EAAE;wBACrCU,eAAe;4BAAE,CAACpF,qBAAqBiB,MAAM,EAAE6D;wBAAI;oBACrD;oBACA3D,SAASJ,KAAK,GAAG+D;gBACnB,GACA,OACA;YAEJrC,0BAA0B;gBACxB,MAAM5B,sBAAsBQ,MAAMR,mBAAmB;gBACrD,MAAMO,gBAAgBC,MAAMD,aAAa;gBACzC,MAAMiE,mBAAmBlG,QAAQ0B,qBAAqB,CAACyE;oBACrDA,MAAMpE,OAAO,CAAC,CAACqE,UAAUC;wBACvB,MAAMvE,OAAOsE,SAASvE,IAAI,CAACC,IAAI;wBAC/B,IAAIsE,SAAShC,IAAI,KAAK,gBAAgB;4BACpC,MAAMkC,kBAAkBrE,cAAcC,GAAG,CAAC;gCAAEJ;4BAAK;4BACjD,IAAIwE,CAAAA,4BAAAA,sCAAAA,gBAAiB1E,KAAK,MAAKZ,WAAW;gCACxCmF,KAAK,CAACE,MAAM,GAAG;oCACbjC,MAAM;oCACNvC,MAAM7B,QAAQoG,SAASvE,IAAI,EAAE,CAAC0E;wCAC5BA,UAAUC,YAAY,GAAGF,gBAAgB1E,KAAK;oCAChD;gCACF;4BACF;wBACF,OAAO,IAAIwE,SAAShC,IAAI,KAAK,gBAAgB;4BAC3C,MAAMkC,kBAAkBrE,cAAcC,GAAG,CAAC;gCAAEJ;4BAAK;4BACjD,MAAM2E,uBAAuB,QAAOH,4BAAAA,sCAAAA,gBAAiB1E,KAAK,MAAK,WAAW0E,gBAAgB1E,KAAK,GAAG;4BAClG,IAAI0E,CAAAA,4BAAAA,sCAAAA,gBAAiB1E,KAAK,MAAKZ,WAAW;gCACxCmF,KAAK,CAACE,MAAM,GAAG;oCACbjC,MAAM;oCACNvC,MAAM7B,QAAQoG,SAASvE,IAAI,EAAE,CAAC0E;wCAC5BA,UAAU3E,KAAK,GAAG6E;oCACpB;gCACF;4BACF;wBACF;oBACF;gBACF;gBACAhB,IACE,CAAC5C;oBACCA,MAAMnB,mBAAmB,GAAGwE;gBAC9B,GACA,OACA;gBAEF,OAAOA;YACT;YACA3C,yBAAyB;gBACvB,OAAO/C,gCAAgC0B,MAAMR,mBAAmB,EAAEQ,MAAMD,aAAa;YACvF;QACF,CAAA;IAIJ,OAAOX;AACT;AA2BA,sHAAsH;AACtH,OAAO,SAASoF,iBAAiB,EAC/B/C,QAAQ,EACR2B,6BAA6B,EAAE,EAC/BlD,8BAA8B,EAAE,EAChCuE,6BAA6B,EAAE,EACT;IACtB,MAAM,CAACrF,MAAM,GAAG5B,SAAS2F,8BAA8B;QAAEC;QAA4BlD;IAA4B;IAEjH,qBACE,KAACrB,+BAA+BoE,QAAQ;QAACvD,OAAON;kBAC9C,cAAA,KAACoC;YAAeE,kBAAkB+C;sBAA6BhD;;;AAGrE;AAEA,OAAO,SAASiD,gCAAgC,EAC9CjD,QAAQ,EACR2B,6BAA6B,EAAE,EAC/BlD,8BAA8B,EAAE,EAChCuE,4BAA4B/C,mBAAmB,EAAE,EAC3B;IACtB,MAAMiD,kBAAkBnG,yBAAyB4E,4BAA4BlD;IAC7E,MAAMmD,cAAczE,uBAAuB+F;IAC3C,MAAM,CAACvF,MAAM,GAAG5B,SACd2F,8BAA8B;QAAEC;QAA4BlD;QAA6BmD;IAAY;IAGvG,qBACE,KAACxE,+BAA+BoE,QAAQ;QAACvD,OAAON;kBAC9C,cAAA,KAACoC;YAAeE,kBAAkBA;sBAAmBD;;;AAG3D"}

package/dist/context/{TemplateVariableProvider → VariableProvider}/hydrationUtils.d.ts

@@ -7,5 +7,5 @@ import { ExternalVariableDefinition } from '@perses-dev/dashboards';
  * @param externalDefinitions external variables definitions. Static part.
  * @param initialValues values coming from query parameters
  */
-export declare function hydrateTemplateVariableStates(localDefinitions: VariableDefinition[], initialValues: Record<string, VariableValue>, externalDefinitions?: ExternalVariableDefinition[]): VariableStoreStateMap;
+export declare function hydrateVariableDefinitionStates(localDefinitions: VariableDefinition[], initialValues: Record<string, VariableValue>, externalDefinitions?: ExternalVariableDefinition[]): VariableStoreStateMap;
 //# sourceMappingURL=hydrationUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hydrationUtils.d.ts","sourceRoot":"","sources":["../../../src/context/VariableProvider/hydrationUtils.ts"],"names":[],"mappings":"AAaA,OAAO,EAAqB,aAAa,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACxF,OAAO,EAAE,qBAAqB,EAAiB,MAAM,2BAA2B,CAAC;AACjF,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAyCpE;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAC7C,gBAAgB,EAAE,kBAAkB,EAAE,EACtC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EAC5C,mBAAmB,GAAE,0BAA0B,EAAO,GACrD,qBAAqB,CAoEvB"}

package/dist/context/{TemplateVariableProvider → VariableProvider}/hydrationUtils.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
@@ -12,8 +12,8 @@
 // limitations under the License.
 import { DEFAULT_ALL_VALUE } from '@perses-dev/core';
 import { VariableStoreStateMap } from '@perses-dev/plugin-system';
-// TODO: move to TemplateVariableProvider/utils.ts
-function hydrateTemplateVariableState(variable, initialValue) {
+// TODO: move to VariableProvider/utils.ts
+function hydrateVariableState(variable, initialValue) {
     const varState = {
         value: null,
         loading: false,
@@ -58,7 +58,7 @@ function hydrateTemplateVariableState(variable, initialValue) {
  * @param localDefinitions local variable definitions. Dynamic part.
  * @param externalDefinitions external variables definitions. Static part.
  * @param initialValues values coming from query parameters
- */ export function hydrateTemplateVariableStates(localDefinitions, initialValues, externalDefinitions = []) {
+ */ export function hydrateVariableDefinitionStates(localDefinitions, initialValues, externalDefinitions = []) {
     const state = new VariableStoreStateMap();
     // Collect the names used by local definitions
     let overridingNames = {};
@@ -78,7 +78,7 @@ function hydrateTemplateVariableState(variable, initialValue) {
                 source,
                 name
             }, {
-                ...hydrateTemplateVariableState(v, initialValue),
+                ...hydrateVariableState(v, initialValue),
                 overridden: !!overridingNames[name]
             });
             overridingNames[name] = true;
@@ -94,7 +94,7 @@ function hydrateTemplateVariableState(variable, initialValue) {
         state.set({
             name
         }, {
-            ...hydrateTemplateVariableState(v, initialValue),
+            ...hydrateVariableState(v, initialValue),
             overriding: !!overriddenNames[name]
         });
     });

package/dist/context/VariableProvider/hydrationUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/context/VariableProvider/hydrationUtils.ts"],"sourcesContent":["// Copyright 2024 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 { DEFAULT_ALL_VALUE, VariableValue, VariableDefinition } from '@perses-dev/core';\nimport { VariableStoreStateMap, VariableState } from '@perses-dev/plugin-system';\nimport { ExternalVariableDefinition } from '@perses-dev/dashboards';\n\n// TODO: move to VariableProvider/utils.ts\nfunction hydrateVariableState(variable: VariableDefinition, initialValue?: VariableValue): VariableState {\n  const varState: VariableState = {\n    value: null,\n    loading: false,\n    overriding: false,\n    overridden: false,\n  };\n  switch (variable.kind) {\n    case 'TextVariable':\n      varState.value = initialValue ?? variable.spec.value;\n      break;\n    case 'ListVariable':\n      varState.options = [];\n      varState.value = initialValue ?? variable.spec.defaultValue ?? null;\n      // TODO: smarter fallbacks for defaultValue when allowAllValue is true\n      if (varState.options.length > 0 && !varState.value) {\n        const firstOptionValue = varState.options[0]?.value ?? null;\n        if (firstOptionValue !== null) {\n          varState.value = variable.spec.allowMultiple ? [firstOptionValue] : firstOptionValue;\n        }\n      }\n\n      // \"all\" variable handling assumes the value is not in an array. This is\n      // handled properly during internal variable interactions, but it is possible\n      // to end up in a buggy state if the variables are initialized with an \"all\"\n      // value inside an array. When hydrating variables, normalize this to minimize\n      // bugs.\n      if (Array.isArray(varState.value) && varState.value.length === 1 && varState.value[0] === DEFAULT_ALL_VALUE) {\n        varState.value = DEFAULT_ALL_VALUE;\n      }\n\n      break;\n    default:\n      break;\n  }\n  return varState;\n}\n\n/**\n * Build the local variable states according to the given definitions\n * @param localDefinitions local variable definitions. Dynamic part.\n * @param externalDefinitions external variables definitions. Static part.\n * @param initialValues values coming from query parameters\n */\nexport function hydrateVariableDefinitionStates(\n  localDefinitions: VariableDefinition[],\n  initialValues: Record<string, VariableValue>,\n  externalDefinitions: ExternalVariableDefinition[] = []\n): VariableStoreStateMap {\n  const state: VariableStoreStateMap = new VariableStoreStateMap();\n\n  // Collect the names used by local definitions\n  let overridingNames: Record<string, boolean> = {};\n  localDefinitions.forEach(\n    (v) => {\n      overridingNames[v.spec.name] = true;\n    },\n    {} as Record<string, boolean>\n  );\n\n  // Then populate the external variables state,\n  // taking care of well flagging each name as used, so the overridden state can be filled accordingly.\n  const overriddenNames: Record<string, boolean> = {};\n  externalDefinitions.forEach(\n    (externalDef) => {\n      const source = externalDef.source;\n      externalDef.definitions.forEach((v) => {\n        const name = v.spec.name;\n        const param = initialValues[name];\n        const initialValue = param ? param : null;\n        state.set(\n          { source, name },\n          {\n            ...hydrateVariableState(v, initialValue),\n            overridden: !!overridingNames[name],\n          }\n        );\n\n        overridingNames[name] = true;\n        overriddenNames[v.spec.name] = true;\n      });\n    },\n    {} as Record<string, boolean>\n  );\n\n  // Then populate the local variables state,\n  // taking care the overriding state is filled according to the names used in external variables.\n  localDefinitions.forEach((v) => {\n    const name = v.spec.name;\n    const param = initialValues[name];\n    const initialValue = param ? param : null;\n    state.set(\n      { name },\n      {\n        ...hydrateVariableState(v, initialValue),\n        overriding: !!overriddenNames[name],\n      }\n    );\n  });\n\n  overridingNames = {};\n  externalDefinitions\n    .slice()\n    .reverse()\n    .forEach((externalDef) => {\n      const source = externalDef.source;\n      externalDef.definitions.forEach((v) => {\n        const name = v.spec.name;\n        const value = state.get({ source, name });\n        if (value) {\n          value.overriding = !!overridingNames[name];\n        }\n        overridingNames[name] = true;\n      });\n    });\n  return state;\n}\n"],"names":["DEFAULT_ALL_VALUE","VariableStoreStateMap","hydrateVariableState","variable","initialValue","varState","value","loading","overriding","overridden","kind","spec","options","defaultValue","length","firstOptionValue","allowMultiple","Array","isArray","hydrateVariableDefinitionStates","localDefinitions","initialValues","externalDefinitions","state","overridingNames","forEach","v","name","overriddenNames","externalDef","source","definitions","param","set","slice","reverse","get"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SAASA,iBAAiB,QAA2C,mBAAmB;AACxF,SAASC,qBAAqB,QAAuB,4BAA4B;AAGjF,0CAA0C;AAC1C,SAASC,qBAAqBC,QAA4B,EAAEC,YAA4B;IACtF,MAAMC,WAA0B;QAC9BC,OAAO;QACPC,SAAS;QACTC,YAAY;QACZC,YAAY;IACd;IACA,OAAQN,SAASO,IAAI;QACnB,KAAK;YACHL,SAASC,KAAK,GAAGF,yBAAAA,0BAAAA,eAAgBD,SAASQ,IAAI,CAACL,KAAK;YACpD;QACF,KAAK;YACHD,SAASO,OAAO,GAAG,EAAE;gBACJR;YAAjBC,SAASC,KAAK,GAAGF,CAAAA,OAAAA,yBAAAA,0BAAAA,eAAgBD,SAASQ,IAAI,CAACE,YAAY,cAA1CT,kBAAAA,OAA8C;YAC/D,sEAAsE;YACtE,IAAIC,SAASO,OAAO,CAACE,MAAM,GAAG,KAAK,CAACT,SAASC,KAAK,EAAE;oBACzBD;oBAAAA;gBAAzB,MAAMU,mBAAmBV,CAAAA,4BAAAA,qBAAAA,SAASO,OAAO,CAAC,EAAE,cAAnBP,yCAAAA,mBAAqBC,KAAK,cAA1BD,sCAAAA,2BAA8B;gBACvD,IAAIU,qBAAqB,MAAM;oBAC7BV,SAASC,KAAK,GAAGH,SAASQ,IAAI,CAACK,aAAa,GAAG;wBAACD;qBAAiB,GAAGA;gBACtE;YACF;YAEA,wEAAwE;YACxE,6EAA6E;YAC7E,4EAA4E;YAC5E,8EAA8E;YAC9E,QAAQ;YACR,IAAIE,MAAMC,OAAO,CAACb,SAASC,KAAK,KAAKD,SAASC,KAAK,CAACQ,MAAM,KAAK,KAAKT,SAASC,KAAK,CAAC,EAAE,KAAKN,mBAAmB;gBAC3GK,SAASC,KAAK,GAAGN;YACnB;YAEA;QACF;YACE;IACJ;IACA,OAAOK;AACT;AAEA;;;;;CAKC,GACD,OAAO,SAASc,gCACdC,gBAAsC,EACtCC,aAA4C,EAC5CC,sBAAoD,EAAE;IAEtD,MAAMC,QAA+B,IAAItB;IAEzC,8CAA8C;IAC9C,IAAIuB,kBAA2C,CAAC;IAChDJ,iBAAiBK,OAAO,CACtB,CAACC;QACCF,eAAe,CAACE,EAAEf,IAAI,CAACgB,IAAI,CAAC,GAAG;IACjC,GACA,CAAC;IAGH,8CAA8C;IAC9C,qGAAqG;IACrG,MAAMC,kBAA2C,CAAC;IAClDN,oBAAoBG,OAAO,CACzB,CAACI;QACC,MAAMC,SAASD,YAAYC,MAAM;QACjCD,YAAYE,WAAW,CAACN,OAAO,CAAC,CAACC;YAC/B,MAAMC,OAAOD,EAAEf,IAAI,CAACgB,IAAI;YACxB,MAAMK,QAAQX,aAAa,CAACM,KAAK;YACjC,MAAMvB,eAAe4B,QAAQA,QAAQ;YACrCT,MAAMU,GAAG,CACP;gBAAEH;gBAAQH;YAAK,GACf;gBACE,GAAGzB,qBAAqBwB,GAAGtB,aAAa;gBACxCK,YAAY,CAAC,CAACe,eAAe,CAACG,KAAK;YACrC;YAGFH,eAAe,CAACG,KAAK,GAAG;YACxBC,eAAe,CAACF,EAAEf,IAAI,CAACgB,IAAI,CAAC,GAAG;QACjC;IACF,GACA,CAAC;IAGH,2CAA2C;IAC3C,gGAAgG;IAChGP,iBAAiBK,OAAO,CAAC,CAACC;QACxB,MAAMC,OAAOD,EAAEf,IAAI,CAACgB,IAAI;QACxB,MAAMK,QAAQX,aAAa,CAACM,KAAK;QACjC,MAAMvB,eAAe4B,QAAQA,QAAQ;QACrCT,MAAMU,GAAG,CACP;YAAEN;QAAK,GACP;YACE,GAAGzB,qBAAqBwB,GAAGtB,aAAa;YACxCI,YAAY,CAAC,CAACoB,eAAe,CAACD,KAAK;QACrC;IAEJ;IAEAH,kBAAkB,CAAC;IACnBF,oBACGY,KAAK,GACLC,OAAO,GACPV,OAAO,CAAC,CAACI;QACR,MAAMC,SAASD,YAAYC,MAAM;QACjCD,YAAYE,WAAW,CAACN,OAAO,CAAC,CAACC;YAC/B,MAAMC,OAAOD,EAAEf,IAAI,CAACgB,IAAI;YACxB,MAAMrB,QAAQiB,MAAMa,GAAG,CAAC;gBAAEN;gBAAQH;YAAK;YACvC,IAAIrB,OAAO;gBACTA,MAAME,UAAU,GAAG,CAAC,CAACgB,eAAe,CAACG,KAAK;YAC5C;YACAH,eAAe,CAACG,KAAK,GAAG;QAC1B;IACF;IACF,OAAOJ;AACT"}

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

@@ -0,0 +1,2 @@
+export * from './VariableProvider';
+//# sourceMappingURL=index.d.ts.map