@perses-dev/plugin-system 0.52.0-beta.5 → 0.52.0-rc.1

package/dist/components/Variables/VariableEditorForm/VariablePreview.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/components/Variables/VariableEditorForm/VariablePreview.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 React, { ReactElement, useState } from 'react';\nimport { Alert, Box, Card, Chip, CircularProgress, IconButton, Stack, Typography } from '@mui/material';\nimport { InfoTooltip, useSnackbar } from '@perses-dev/components';\nimport Refresh from 'mdi-material-ui/Refresh';\nimport Clipboard from 'mdi-material-ui/ClipboardOutline';\nimport { ListVariableDefinition } from '@perses-dev/core';\nimport { TOOLTIP_TEXT } from '../../../constants';\nimport { useListVariablePluginValues } from '../variable-model';\n\nconst DEFAULT_MAX_PREVIEW_VALUES = 50;\n\ninterface VariablePreviewProps {\n  values?: string[];\n  onRefresh?: () => void;\n  isLoading?: boolean;\n  error?: string;\n}\n\nexport function VariablePreview(props: VariablePreviewProps): ReactElement {\n  const { values, onRefresh, isLoading, error } = props;\n  const [maxValues, setMaxValues] = useState<number | undefined>(DEFAULT_MAX_PREVIEW_VALUES);\n  const { infoSnackbar } = useSnackbar();\n  const showAll = (): void => {\n    setMaxValues(undefined);\n  };\n  let notShown = 0;\n\n  if (values && values?.length > 0 && maxValues) {\n    notShown = values.length - maxValues;\n  }\n\n  return (\n    <Box>\n      <Stack direction=\"row\" spacing={1} alignItems=\"center\" mb={1}>\n        <Typography variant=\"h4\">Preview Values</Typography>\n        {onRefresh && (\n          <InfoTooltip description={TOOLTIP_TEXT.refreshVariableValues}>\n            <IconButton onClick={onRefresh} size=\"small\">\n              <Refresh />\n            </IconButton>\n          </InfoTooltip>\n        )}\n        <InfoTooltip description={TOOLTIP_TEXT.copyVariableValues}>\n          <IconButton\n            onClick={async () => {\n              if (values?.length) {\n                await navigator.clipboard.writeText(values.map((value) => value).join(', '));\n                infoSnackbar('Preview values copied to clipboard!');\n              }\n            }}\n            size=\"small\"\n          >\n            <Clipboard />\n          </IconButton>\n        </InfoTooltip>\n      </Stack>\n      <Card variant=\"outlined\">\n        <Box sx={{ display: 'flex', flexWrap: 'wrap', gap: 1, m: 2 }}>\n          {error && <Alert severity=\"error\">{error}</Alert>}\n          {values?.length === 0 && <Alert severity=\"info\">No results</Alert>}\n          {isLoading && (\n            <Stack width=\"100%\" sx={{ alignItems: 'center', justifyContent: 'center' }}>\n              <CircularProgress />\n            </Stack>\n          )}\n          {values?.slice(0, maxValues).map((val, index) => <Chip size=\"small\" key={index} label={val} />)}\n          {notShown > 0 && <Chip onClick={showAll} variant=\"outlined\" size=\"small\" label={`+${notShown} more`} />}\n        </Box>\n      </Card>\n    </Box>\n  );\n}\n\ninterface VariableListPreviewProps {\n  definition: ListVariableDefinition;\n  onRefresh: () => void;\n}\n\nexport function VariableListPreview(props: VariableListPreviewProps): ReactElement {\n  const { definition, onRefresh } = props;\n  const { data, isFetching, error } = useListVariablePluginValues(definition);\n  const errorMessage = (error as Error)?.message;\n\n  return (\n    <VariablePreview\n      values={data?.map((val) => val.value) || []}\n      onRefresh={onRefresh}\n      isLoading={isFetching}\n      error={errorMessage}\n    />\n  );\n}\n"],"names":["React","useState","Alert","Box","Card","Chip","CircularProgress","IconButton","Stack","Typography","InfoTooltip","useSnackbar","Refresh","Clipboard","TOOLTIP_TEXT","useListVariablePluginValues","DEFAULT_MAX_PREVIEW_VALUES","VariablePreview","props","values","onRefresh","isLoading","error","maxValues","setMaxValues","infoSnackbar","showAll","undefined","notShown","length","direction","spacing","alignItems","mb","variant","description","refreshVariableValues","onClick","size","copyVariableValues","navigator","clipboard","writeText","map","value","join","sx","display","flexWrap","gap","m","severity","width","justifyContent","slice","val","index","label","VariableListPreview","definition","data","isFetching","errorMessage","message"],"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,OAAOA,SAAuBC,QAAQ,QAAQ,QAAQ;AACtD,SAASC,KAAK,EAAEC,GAAG,EAAEC,IAAI,EAAEC,IAAI,EAAEC,gBAAgB,EAAEC,UAAU,EAAEC,KAAK,EAAEC,UAAU,QAAQ,gBAAgB;AACxG,SAASC,WAAW,EAAEC,WAAW,QAAQ,yBAAyB;AAClE,OAAOC,aAAa,0BAA0B;AAC9C,OAAOC,eAAe,mCAAmC;AAEzD,SAASC,YAAY,QAAQ,qBAAqB;AAClD,SAASC,2BAA2B,QAAQ,oBAAoB;AAEhE,MAAMC,6BAA6B;AASnC,OAAO,SAASC,gBAAgBC,KAA2B;IACzD,MAAM,EAAEC,MAAM,EAAEC,SAAS,EAAEC,SAAS,EAAEC,KAAK,EAAE,GAAGJ;IAChD,MAAM,CAACK,WAAWC,aAAa,GAAGvB,SAA6Be;IAC/D,MAAM,EAAES,YAAY,EAAE,GAAGd;IACzB,MAAMe,UAAU;QACdF,aAAaG;IACf;IACA,IAAIC,WAAW;IAEf,IAAIT,UAAUA,QAAQU,SAAS,KAAKN,WAAW;QAC7CK,WAAWT,OAAOU,MAAM,GAAGN;IAC7B;IAEA,qBACE,MAACpB;;0BACC,MAACK;gBAAMsB,WAAU;gBAAMC,SAAS;gBAAGC,YAAW;gBAASC,IAAI;;kCACzD,KAACxB;wBAAWyB,SAAQ;kCAAK;;oBACxBd,2BACC,KAACV;wBAAYyB,aAAarB,aAAasB,qBAAqB;kCAC1D,cAAA,KAAC7B;4BAAW8B,SAASjB;4BAAWkB,MAAK;sCACnC,cAAA,KAAC1B;;;kCAIP,KAACF;wBAAYyB,aAAarB,aAAayB,kBAAkB;kCACvD,cAAA,KAAChC;4BACC8B,SAAS;gCACP,IAAIlB,QAAQU,QAAQ;oCAClB,MAAMW,UAAUC,SAAS,CAACC,SAAS,CAACvB,OAAOwB,GAAG,CAAC,CAACC,QAAUA,OAAOC,IAAI,CAAC;oCACtEpB,aAAa;gCACf;4BACF;4BACAa,MAAK;sCAEL,cAAA,KAACzB;;;;;0BAIP,KAACT;gBAAK8B,SAAQ;0BACZ,cAAA,MAAC/B;oBAAI2C,IAAI;wBAAEC,SAAS;wBAAQC,UAAU;wBAAQC,KAAK;wBAAGC,GAAG;oBAAE;;wBACxD5B,uBAAS,KAACpB;4BAAMiD,UAAS;sCAAS7B;;wBAClCH,QAAQU,WAAW,mBAAK,KAAC3B;4BAAMiD,UAAS;sCAAO;;wBAC/C9B,2BACC,KAACb;4BAAM4C,OAAM;4BAAON,IAAI;gCAAEd,YAAY;gCAAUqB,gBAAgB;4BAAS;sCACvE,cAAA,KAAC/C;;wBAGJa,QAAQmC,MAAM,GAAG/B,WAAWoB,IAAI,CAACY,KAAKC,sBAAU,KAACnD;gCAAKiC,MAAK;gCAAoBmB,OAAOF;+BAAdC;wBACxE5B,WAAW,mBAAK,KAACvB;4BAAKgC,SAASX;4BAASQ,SAAQ;4BAAWI,MAAK;4BAAQmB,OAAO,CAAC,CAAC,EAAE7B,SAAS,KAAK,CAAC;;;;;;;AAK7G;AAOA,OAAO,SAAS8B,oBAAoBxC,KAA+B;IACjE,MAAM,EAAEyC,UAAU,EAAEvC,SAAS,EAAE,GAAGF;IAClC,MAAM,EAAE0C,IAAI,EAAEC,UAAU,EAAEvC,KAAK,EAAE,GAAGP,4BAA4B4C;IAChE,MAAMG,eAAgBxC,OAAiByC;IAEvC,qBACE,KAAC9C;QACCE,QAAQyC,MAAMjB,IAAI,CAACY,MAAQA,IAAIX,KAAK,KAAK,EAAE;QAC3CxB,WAAWA;QACXC,WAAWwC;QACXvC,OAAOwC;;AAGb"}
+{"version":3,"sources":["../../../../src/components/Variables/VariableEditorForm/VariablePreview.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 React, { ReactElement, useMemo, useState } from 'react';\nimport { Alert, Box, Card, Chip, CircularProgress, IconButton, Stack, Typography } from '@mui/material';\nimport { InfoTooltip, useSnackbar } from '@perses-dev/components';\nimport Clipboard from 'mdi-material-ui/ClipboardOutline';\nimport { ListVariableDefinition } from '@perses-dev/core';\nimport { TOOLTIP_TEXT } from '../../../constants';\nimport { useListVariablePluginValues } from '../variable-model';\n\nconst DEFAULT_MAX_PREVIEW_VALUES = 50;\n\ninterface VariablePreviewProps {\n  values?: string[];\n  isLoading?: boolean;\n  error?: string;\n}\n\nexport function VariablePreview(props: VariablePreviewProps): ReactElement {\n  const { values, isLoading, error } = props;\n  const [maxValues, setMaxValues] = useState<number | undefined>(DEFAULT_MAX_PREVIEW_VALUES);\n  const { infoSnackbar } = useSnackbar();\n  const showAll = (): void => {\n    setMaxValues(undefined);\n  };\n  let notShown = 0;\n\n  if (values && values?.length > 0 && maxValues) {\n    notShown = values.length - maxValues;\n  }\n\n  return (\n    <Box>\n      <Stack direction=\"row\" spacing={1} alignItems=\"center\" mb={1}>\n        <Typography variant=\"h4\">Preview Values</Typography>\n        <InfoTooltip description={TOOLTIP_TEXT.copyVariableValues}>\n          <IconButton\n            onClick={async () => {\n              if (values?.length) {\n                await navigator.clipboard.writeText(values.map((value) => value).join(', '));\n                infoSnackbar('Preview values copied to clipboard!');\n              }\n            }}\n            size=\"small\"\n          >\n            <Clipboard />\n          </IconButton>\n        </InfoTooltip>\n      </Stack>\n      <Card variant=\"outlined\">\n        <Box sx={{ display: 'flex', flexWrap: 'wrap', gap: 1, m: 2 }}>\n          {error && <Alert severity=\"error\">{error}</Alert>}\n          {values?.length === 0 && <Alert severity=\"info\">No results</Alert>}\n          {isLoading && (\n            <Stack width=\"100%\" sx={{ alignItems: 'center', justifyContent: 'center' }}>\n              <CircularProgress />\n            </Stack>\n          )}\n          {values?.slice(0, maxValues).map((val, index) => <Chip size=\"small\" key={index} label={val} />)}\n          {notShown > 0 && <Chip onClick={showAll} variant=\"outlined\" size=\"small\" label={`+${notShown} more`} />}\n        </Box>\n      </Card>\n    </Box>\n  );\n}\n\ninterface VariableListPreviewProps {\n  definition: ListVariableDefinition;\n}\n\nexport function VariableListPreview(props: VariableListPreviewProps): ReactElement {\n  const { definition } = props;\n  const { data, isFetching, error } = useListVariablePluginValues(definition);\n  const errorMessage = (error as Error)?.message;\n\n  const variablePreview = useMemo(\n    () => <VariablePreview values={data?.map((val) => val.value) || []} isLoading={isFetching} error={errorMessage} />,\n    [errorMessage, isFetching, data]\n  );\n\n  return variablePreview;\n}\n"],"names":["React","useMemo","useState","Alert","Box","Card","Chip","CircularProgress","IconButton","Stack","Typography","InfoTooltip","useSnackbar","Clipboard","TOOLTIP_TEXT","useListVariablePluginValues","DEFAULT_MAX_PREVIEW_VALUES","VariablePreview","props","values","isLoading","error","maxValues","setMaxValues","infoSnackbar","showAll","undefined","notShown","length","direction","spacing","alignItems","mb","variant","description","copyVariableValues","onClick","navigator","clipboard","writeText","map","value","join","size","sx","display","flexWrap","gap","m","severity","width","justifyContent","slice","val","index","label","VariableListPreview","definition","data","isFetching","errorMessage","message","variablePreview"],"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,OAAOA,SAAuBC,OAAO,EAAEC,QAAQ,QAAQ,QAAQ;AAC/D,SAASC,KAAK,EAAEC,GAAG,EAAEC,IAAI,EAAEC,IAAI,EAAEC,gBAAgB,EAAEC,UAAU,EAAEC,KAAK,EAAEC,UAAU,QAAQ,gBAAgB;AACxG,SAASC,WAAW,EAAEC,WAAW,QAAQ,yBAAyB;AAClE,OAAOC,eAAe,mCAAmC;AAEzD,SAASC,YAAY,QAAQ,qBAAqB;AAClD,SAASC,2BAA2B,QAAQ,oBAAoB;AAEhE,MAAMC,6BAA6B;AAQnC,OAAO,SAASC,gBAAgBC,KAA2B;IACzD,MAAM,EAAEC,MAAM,EAAEC,SAAS,EAAEC,KAAK,EAAE,GAAGH;IACrC,MAAM,CAACI,WAAWC,aAAa,GAAGrB,SAA6Bc;IAC/D,MAAM,EAAEQ,YAAY,EAAE,GAAGZ;IACzB,MAAMa,UAAU;QACdF,aAAaG;IACf;IACA,IAAIC,WAAW;IAEf,IAAIR,UAAUA,QAAQS,SAAS,KAAKN,WAAW;QAC7CK,WAAWR,OAAOS,MAAM,GAAGN;IAC7B;IAEA,qBACE,MAAClB;;0BACC,MAACK;gBAAMoB,WAAU;gBAAMC,SAAS;gBAAGC,YAAW;gBAASC,IAAI;;kCACzD,KAACtB;wBAAWuB,SAAQ;kCAAK;;kCACzB,KAACtB;wBAAYuB,aAAapB,aAAaqB,kBAAkB;kCACvD,cAAA,KAAC3B;4BACC4B,SAAS;gCACP,IAAIjB,QAAQS,QAAQ;oCAClB,MAAMS,UAAUC,SAAS,CAACC,SAAS,CAACpB,OAAOqB,GAAG,CAAC,CAACC,QAAUA,OAAOC,IAAI,CAAC;oCACtElB,aAAa;gCACf;4BACF;4BACAmB,MAAK;sCAEL,cAAA,KAAC9B;;;;;0BAIP,KAACR;gBAAK4B,SAAQ;0BACZ,cAAA,MAAC7B;oBAAIwC,IAAI;wBAAEC,SAAS;wBAAQC,UAAU;wBAAQC,KAAK;wBAAGC,GAAG;oBAAE;;wBACxD3B,uBAAS,KAAClB;4BAAM8C,UAAS;sCAAS5B;;wBAClCF,QAAQS,WAAW,mBAAK,KAACzB;4BAAM8C,UAAS;sCAAO;;wBAC/C7B,2BACC,KAACX;4BAAMyC,OAAM;4BAAON,IAAI;gCAAEb,YAAY;gCAAUoB,gBAAgB;4BAAS;sCACvE,cAAA,KAAC5C;;wBAGJY,QAAQiC,MAAM,GAAG9B,WAAWkB,IAAI,CAACa,KAAKC,sBAAU,KAAChD;gCAAKqC,MAAK;gCAAoBY,OAAOF;+BAAdC;wBACxE3B,WAAW,mBAAK,KAACrB;4BAAK8B,SAASX;4BAASQ,SAAQ;4BAAWU,MAAK;4BAAQY,OAAO,CAAC,CAAC,EAAE5B,SAAS,KAAK,CAAC;;;;;;;AAK7G;AAMA,OAAO,SAAS6B,oBAAoBtC,KAA+B;IACjE,MAAM,EAAEuC,UAAU,EAAE,GAAGvC;IACvB,MAAM,EAAEwC,IAAI,EAAEC,UAAU,EAAEtC,KAAK,EAAE,GAAGN,4BAA4B0C;IAChE,MAAMG,eAAgBvC,OAAiBwC;IAEvC,MAAMC,kBAAkB7D,QACtB,kBAAM,KAACgB;YAAgBE,QAAQuC,MAAMlB,IAAI,CAACa,MAAQA,IAAIZ,KAAK,KAAK,EAAE;YAAErB,WAAWuC;YAAYtC,OAAOuC;YAClG;QAACA;QAAcD;QAAYD;KAAK;IAGlC,OAAOI;AACT"}

package/dist/context/query-params.js

@@ -11,12 +11,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { useCallback, useState } from 'react';
-import { useQueryParams } from 'use-query-params';
+import { parseAsString, useQueryStates } from 'nuqs';
 export function useSetProjectParams(enabledURLParams = true) {
-    const [query, setQuery] = useQueryParams({
-        project: ''
+    const [query, setQuery] = useQueryStates({
+        project: parseAsString
     }, {
-        updateType: 'replaceIn'
+        history: 'replace'
     });
     const [projectState, setProjectState] = useState('none');
     const setProject = useCallback((project)=>{

package/dist/context/query-params.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/context/query-params.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { useCallback, useState } from 'react';\nimport { useQueryParams } from 'use-query-params';\n\nexport function useSetProjectParams(enabledURLParams = true): {\n  project: string;\n  setProject: (project: string) => void;\n} {\n  const [query, setQuery] = useQueryParams({ project: '' }, { updateType: 'replaceIn' });\n\n  const [projectState, setProjectState] = useState<string>('none');\n\n  const setProject = useCallback(\n    (project: string) => {\n      return setQuery({ project });\n    },\n    [setQuery]\n  );\n\n  if (enabledURLParams) {\n    return {\n      project: query.project || 'none',\n      setProject,\n    };\n  }\n\n  return {\n    project: projectState,\n    setProject: setProjectState,\n  };\n}\n"],"names":["useCallback","useState","useQueryParams","useSetProjectParams","enabledURLParams","query","setQuery","project","updateType","projectState","setProjectState","setProject"],"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,WAAW,EAAEC,QAAQ,QAAQ,QAAQ;AAC9C,SAASC,cAAc,QAAQ,mBAAmB;AAElD,OAAO,SAASC,oBAAoBC,mBAAmB,IAAI;IAIzD,MAAM,CAACC,OAAOC,SAAS,GAAGJ,eAAe;QAAEK,SAAS;IAAG,GAAG;QAAEC,YAAY;IAAY;IAEpF,MAAM,CAACC,cAAcC,gBAAgB,GAAGT,SAAiB;IAEzD,MAAMU,aAAaX,YACjB,CAACO;QACC,OAAOD,SAAS;YAAEC;QAAQ;IAC5B,GACA;QAACD;KAAS;IAGZ,IAAIF,kBAAkB;QACpB,OAAO;YACLG,SAASF,MAAME,OAAO,IAAI;YAC1BI;QACF;IACF;IAEA,OAAO;QACLJ,SAASE;QACTE,YAAYD;IACd;AACF"}
+{"version":3,"sources":["../../src/context/query-params.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { useCallback, useState } from 'react';\nimport { parseAsString, useQueryStates } from 'nuqs';\n\nexport function useSetProjectParams(enabledURLParams = true): {\n  project: string;\n  setProject: (project: string) => void;\n} {\n  const [query, setQuery] = useQueryStates({ project: parseAsString }, { history: 'replace' });\n\n  const [projectState, setProjectState] = useState<string>('none');\n\n  const setProject = useCallback(\n    (project: string) => {\n      return setQuery({ project });\n    },\n    [setQuery]\n  );\n\n  if (enabledURLParams) {\n    return {\n      project: query.project || 'none',\n      setProject,\n    };\n  }\n\n  return {\n    project: projectState,\n    setProject: setProjectState,\n  };\n}\n"],"names":["useCallback","useState","parseAsString","useQueryStates","useSetProjectParams","enabledURLParams","query","setQuery","project","history","projectState","setProjectState","setProject"],"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,WAAW,EAAEC,QAAQ,QAAQ,QAAQ;AAC9C,SAASC,aAAa,EAAEC,cAAc,QAAQ,OAAO;AAErD,OAAO,SAASC,oBAAoBC,mBAAmB,IAAI;IAIzD,MAAM,CAACC,OAAOC,SAAS,GAAGJ,eAAe;QAAEK,SAASN;IAAc,GAAG;QAAEO,SAAS;IAAU;IAE1F,MAAM,CAACC,cAAcC,gBAAgB,GAAGV,SAAiB;IAEzD,MAAMW,aAAaZ,YACjB,CAACQ;QACC,OAAOD,SAAS;YAAEC;QAAQ;IAC5B,GACA;QAACD;KAAS;IAGZ,IAAIF,kBAAkB;QACpB,OAAO;YACLG,SAASF,MAAME,OAAO,IAAI;YAC1BI;QACF;IACF;IAEA,OAAO;QACLJ,SAASE;QACTE,YAAYD;IACd;AACF"}

package/dist/runtime/TimeRangeProvider/TimeRangeProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TimeRangeProvider.d.ts","sourceRoot":"","sources":["../../../src/runtime/TimeRangeProvider/TimeRangeProvider.tsx"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,EAAiB,YAAY,EAAyD,MAAM,OAAO,CAAC;AAClH,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,cAAc,EAIf,MAAM,kBAAkB,CAAC;AAG1B,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,cAAc,CAAC;IAC1B,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IAC/C,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IACrD,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,cAAc,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,YAAY,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IAC9C,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;CACrD;AAED,eAAO,MAAM,gBAAgB,sCAAkD,CAAC;AAEhF,wBAAgB,mBAAmB,IAAI,SAAS,CAM/C;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,SAAS,CAExC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAIzD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,GAAG,YAAY,CAwD7E"}
+{"version":3,"file":"TimeRangeProvider.d.ts","sourceRoot":"","sources":["../../../src/runtime/TimeRangeProvider/TimeRangeProvider.tsx"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,EAAiB,YAAY,EAAyD,MAAM,OAAO,CAAC;AAClH,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,cAAc,EAIf,MAAM,kBAAkB,CAAC;AAG1B,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,cAAc,CAAC;IAC1B,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IAC/C,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IACrD,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,cAAc,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,YAAY,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IAC9C,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;CACrD;AAED,eAAO,MAAM,gBAAgB,sCAAkD,CAAC;AAEhF,wBAAgB,mBAAmB,IAAI,SAAS,CAM/C;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,SAAS,CAExC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAIzD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,GAAG,YAAY,CA+D7E"}

package/dist/runtime/TimeRangeProvider/TimeRangeProvider.js

@@ -38,7 +38,12 @@ export function useTimeRangeContext() {
  * Provider implementation that supplies the time range state at runtime.
  */ export function TimeRangeProvider(props) {
     const { timeRange, refreshInterval, children, setTimeRange, setRefreshInterval } = props;
-    const [localTimeRange, setLocalTimeRange] = useState(timeRange);
+    /**
+   * TODO: The hook needs refactor. There is a bug here with refreshKey. If the refreshInterval is not set,
+   * refreshKey string includes an undefined xx:yy:zz:undefined:0
+   * I think exposing refresh functionality also is very risky. A careless usage of refresh may cause
+   * infinite rendering loop.
+   */ const [localTimeRange, setLocalTimeRange] = useState(timeRange);
     const [localRefreshInterval, setLocalRefreshInterval] = useState(refreshInterval);
     const [refreshCounter, setRefreshCounter] = useState(0);
     useEffect(()=>{

package/dist/runtime/TimeRangeProvider/TimeRangeProvider.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/runtime/TimeRangeProvider/TimeRangeProvider.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 React, { createContext, ReactElement, useCallback, useContext, useEffect, useMemo, useState } from 'react';\nimport {\n  AbsoluteTimeRange,\n  DurationString,\n  TimeRangeValue,\n  isRelativeTimeRange,\n  toAbsoluteTimeRange,\n  getSuggestedStepMs,\n} from '@perses-dev/core';\nimport { getRefreshIntervalInMs } from './refresh-interval';\n\nexport interface TimeRangeProviderProps {\n  timeRange: TimeRangeValue;\n  refreshInterval?: DurationString;\n  setTimeRange?: (value: TimeRangeValue) => void;\n  setRefreshInterval?: (value: DurationString) => void;\n  children?: React.ReactNode;\n}\n\nexport interface TimeRange {\n  timeRange: TimeRangeValue;\n  absoluteTimeRange: AbsoluteTimeRange; // resolved absolute time for plugins to use\n  setTimeRange: (value: TimeRangeValue) => void;\n  refresh: () => void;\n  refreshKey: string;\n  refreshInterval?: DurationString;\n  refreshIntervalInMs: number;\n  setRefreshInterval: (value: DurationString) => void;\n}\n\nexport const TimeRangeContext = createContext<TimeRange | undefined>(undefined);\n\nexport function useTimeRangeContext(): TimeRange {\n  const ctx = useContext(TimeRangeContext);\n  if (ctx === undefined) {\n    throw new Error('No TimeRangeContext found. Did you forget a Provider?');\n  }\n  return ctx;\n}\n\n/**\n * Get and set the current resolved time range at runtime.\n */\nexport function useTimeRange(): TimeRange {\n  return useTimeRangeContext();\n}\n\n/**\n * Gets the suggested step for a graph query in ms for the currently selected time range.\n */\nexport function useSuggestedStepMs(width?: number): number {\n  const { absoluteTimeRange } = useTimeRange();\n  if (width === undefined) return 0;\n  return getSuggestedStepMs(absoluteTimeRange, width);\n}\n\n/**\n * Provider implementation that supplies the time range state at runtime.\n */\nexport function TimeRangeProvider(props: TimeRangeProviderProps): ReactElement {\n  const { timeRange, refreshInterval, children, setTimeRange, setRefreshInterval } = props;\n\n  const [localTimeRange, setLocalTimeRange] = useState<TimeRangeValue>(timeRange);\n  const [localRefreshInterval, setLocalRefreshInterval] = useState<DurationString | undefined>(refreshInterval);\n\n  const [refreshCounter, setRefreshCounter] = useState(0);\n\n  useEffect(() => {\n    setLocalTimeRange(timeRange);\n  }, [timeRange, refreshCounter]);\n\n  useEffect(() => {\n    setLocalRefreshInterval(refreshInterval);\n  }, [refreshInterval]);\n\n  const refresh = useCallback(() => {\n    setRefreshCounter((counter) => counter + 1);\n  }, [setRefreshCounter]);\n\n  const refreshIntervalInMs = getRefreshIntervalInMs(localRefreshInterval);\n  useEffect(() => {\n    if (refreshIntervalInMs > 0) {\n      const interval = setInterval(() => {\n        refresh();\n      }, refreshIntervalInMs);\n\n      return (): void => clearInterval(interval);\n    }\n  }, [refresh, refreshIntervalInMs]);\n\n  const ctx = useMemo(() => {\n    const absoluteTimeRange = isRelativeTimeRange(localTimeRange)\n      ? toAbsoluteTimeRange(localTimeRange)\n      : localTimeRange;\n    return {\n      timeRange: localTimeRange,\n      setTimeRange: setTimeRange ?? setLocalTimeRange,\n      absoluteTimeRange,\n      refresh,\n      refreshKey: `${absoluteTimeRange.start}:${absoluteTimeRange.end}:${localRefreshInterval}:${refreshCounter}`,\n      refreshInterval: localRefreshInterval,\n      refreshIntervalInMs: refreshIntervalInMs,\n      setRefreshInterval: setRefreshInterval ?? setLocalRefreshInterval,\n    };\n  }, [\n    localTimeRange,\n    setTimeRange,\n    refresh,\n    localRefreshInterval,\n    refreshCounter,\n    refreshIntervalInMs,\n    setRefreshInterval,\n  ]);\n\n  return <TimeRangeContext.Provider value={ctx}>{children}</TimeRangeContext.Provider>;\n}\n"],"names":["React","createContext","useCallback","useContext","useEffect","useMemo","useState","isRelativeTimeRange","toAbsoluteTimeRange","getSuggestedStepMs","getRefreshIntervalInMs","TimeRangeContext","undefined","useTimeRangeContext","ctx","Error","useTimeRange","useSuggestedStepMs","width","absoluteTimeRange","TimeRangeProvider","props","timeRange","refreshInterval","children","setTimeRange","setRefreshInterval","localTimeRange","setLocalTimeRange","localRefreshInterval","setLocalRefreshInterval","refreshCounter","setRefreshCounter","refresh","counter","refreshIntervalInMs","interval","setInterval","clearInterval","refreshKey","start","end","Provider","value"],"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,OAAOA,SAASC,aAAa,EAAgBC,WAAW,EAAEC,UAAU,EAAEC,SAAS,EAAEC,OAAO,EAAEC,QAAQ,QAAQ,QAAQ;AAClH,SAIEC,mBAAmB,EACnBC,mBAAmB,EACnBC,kBAAkB,QACb,mBAAmB;AAC1B,SAASC,sBAAsB,QAAQ,qBAAqB;AAqB5D,OAAO,MAAMC,iCAAmBV,cAAqCW,WAAW;AAEhF,OAAO,SAASC;IACd,MAAMC,MAAMX,WAAWQ;IACvB,IAAIG,QAAQF,WAAW;QACrB,MAAM,IAAIG,MAAM;IAClB;IACA,OAAOD;AACT;AAEA;;CAEC,GACD,OAAO,SAASE;IACd,OAAOH;AACT;AAEA;;CAEC,GACD,OAAO,SAASI,mBAAmBC,KAAc;IAC/C,MAAM,EAAEC,iBAAiB,EAAE,GAAGH;IAC9B,IAAIE,UAAUN,WAAW,OAAO;IAChC,OAAOH,mBAAmBU,mBAAmBD;AAC/C;AAEA;;CAEC,GACD,OAAO,SAASE,kBAAkBC,KAA6B;IAC7D,MAAM,EAAEC,SAAS,EAAEC,eAAe,EAAEC,QAAQ,EAAEC,YAAY,EAAEC,kBAAkB,EAAE,GAAGL;IAEnF,MAAM,CAACM,gBAAgBC,kBAAkB,GAAGtB,SAAyBgB;IACrE,MAAM,CAACO,sBAAsBC,wBAAwB,GAAGxB,SAAqCiB;IAE7F,MAAM,CAACQ,gBAAgBC,kBAAkB,GAAG1B,SAAS;IAErDF,UAAU;QACRwB,kBAAkBN;IACpB,GAAG;QAACA;QAAWS;KAAe;IAE9B3B,UAAU;QACR0B,wBAAwBP;IAC1B,GAAG;QAACA;KAAgB;IAEpB,MAAMU,UAAU/B,YAAY;QAC1B8B,kBAAkB,CAACE,UAAYA,UAAU;IAC3C,GAAG;QAACF;KAAkB;IAEtB,MAAMG,sBAAsBzB,uBAAuBmB;IACnDzB,UAAU;QACR,IAAI+B,sBAAsB,GAAG;YAC3B,MAAMC,WAAWC,YAAY;gBAC3BJ;YACF,GAAGE;YAEH,OAAO,IAAYG,cAAcF;QACnC;IACF,GAAG;QAACH;QAASE;KAAoB;IAEjC,MAAMrB,MAAMT,QAAQ;QAClB,MAAMc,oBAAoBZ,oBAAoBoB,kBAC1CnB,oBAAoBmB,kBACpBA;QACJ,OAAO;YACLL,WAAWK;YACXF,cAAcA,gBAAgBG;YAC9BT;YACAc;YACAM,YAAY,GAAGpB,kBAAkBqB,KAAK,CAAC,CAAC,EAAErB,kBAAkBsB,GAAG,CAAC,CAAC,EAAEZ,qBAAqB,CAAC,EAAEE,gBAAgB;YAC3GR,iBAAiBM;YACjBM,qBAAqBA;YACrBT,oBAAoBA,sBAAsBI;QAC5C;IACF,GAAG;QACDH;QACAF;QACAQ;QACAJ;QACAE;QACAI;QACAT;KACD;IAED,qBAAO,KAACf,iBAAiB+B,QAAQ;QAACC,OAAO7B;kBAAMU;;AACjD"}
+{"version":3,"sources":["../../../src/runtime/TimeRangeProvider/TimeRangeProvider.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 React, { createContext, ReactElement, useCallback, useContext, useEffect, useMemo, useState } from 'react';\nimport {\n  AbsoluteTimeRange,\n  DurationString,\n  TimeRangeValue,\n  isRelativeTimeRange,\n  toAbsoluteTimeRange,\n  getSuggestedStepMs,\n} from '@perses-dev/core';\nimport { getRefreshIntervalInMs } from './refresh-interval';\n\nexport interface TimeRangeProviderProps {\n  timeRange: TimeRangeValue;\n  refreshInterval?: DurationString;\n  setTimeRange?: (value: TimeRangeValue) => void;\n  setRefreshInterval?: (value: DurationString) => void;\n  children?: React.ReactNode;\n}\n\nexport interface TimeRange {\n  timeRange: TimeRangeValue;\n  absoluteTimeRange: AbsoluteTimeRange; // resolved absolute time for plugins to use\n  setTimeRange: (value: TimeRangeValue) => void;\n  refresh: () => void;\n  refreshKey: string;\n  refreshInterval?: DurationString;\n  refreshIntervalInMs: number;\n  setRefreshInterval: (value: DurationString) => void;\n}\n\nexport const TimeRangeContext = createContext<TimeRange | undefined>(undefined);\n\nexport function useTimeRangeContext(): TimeRange {\n  const ctx = useContext(TimeRangeContext);\n  if (ctx === undefined) {\n    throw new Error('No TimeRangeContext found. Did you forget a Provider?');\n  }\n  return ctx;\n}\n\n/**\n * Get and set the current resolved time range at runtime.\n */\nexport function useTimeRange(): TimeRange {\n  return useTimeRangeContext();\n}\n\n/**\n * Gets the suggested step for a graph query in ms for the currently selected time range.\n */\nexport function useSuggestedStepMs(width?: number): number {\n  const { absoluteTimeRange } = useTimeRange();\n  if (width === undefined) return 0;\n  return getSuggestedStepMs(absoluteTimeRange, width);\n}\n\n/**\n * Provider implementation that supplies the time range state at runtime.\n */\nexport function TimeRangeProvider(props: TimeRangeProviderProps): ReactElement {\n  const { timeRange, refreshInterval, children, setTimeRange, setRefreshInterval } = props;\n\n  /**\n   * TODO: The hook needs refactor. There is a bug here with refreshKey. If the refreshInterval is not set,\n   * refreshKey string includes an undefined xx:yy:zz:undefined:0\n   * I think exposing refresh functionality also is very risky. A careless usage of refresh may cause\n   * infinite rendering loop.\n   */\n\n  const [localTimeRange, setLocalTimeRange] = useState<TimeRangeValue>(timeRange);\n  const [localRefreshInterval, setLocalRefreshInterval] = useState<DurationString | undefined>(refreshInterval);\n\n  const [refreshCounter, setRefreshCounter] = useState(0);\n\n  useEffect(() => {\n    setLocalTimeRange(timeRange);\n  }, [timeRange, refreshCounter]);\n\n  useEffect(() => {\n    setLocalRefreshInterval(refreshInterval);\n  }, [refreshInterval]);\n\n  const refresh = useCallback(() => {\n    setRefreshCounter((counter) => counter + 1);\n  }, [setRefreshCounter]);\n\n  const refreshIntervalInMs = getRefreshIntervalInMs(localRefreshInterval);\n  useEffect(() => {\n    if (refreshIntervalInMs > 0) {\n      const interval = setInterval(() => {\n        refresh();\n      }, refreshIntervalInMs);\n\n      return (): void => clearInterval(interval);\n    }\n  }, [refresh, refreshIntervalInMs]);\n\n  const ctx = useMemo(() => {\n    const absoluteTimeRange = isRelativeTimeRange(localTimeRange)\n      ? toAbsoluteTimeRange(localTimeRange)\n      : localTimeRange;\n    return {\n      timeRange: localTimeRange,\n      setTimeRange: setTimeRange ?? setLocalTimeRange,\n      absoluteTimeRange,\n      refresh,\n      refreshKey: `${absoluteTimeRange.start}:${absoluteTimeRange.end}:${localRefreshInterval}:${refreshCounter}`,\n      refreshInterval: localRefreshInterval,\n      refreshIntervalInMs: refreshIntervalInMs,\n      setRefreshInterval: setRefreshInterval ?? setLocalRefreshInterval,\n    };\n  }, [\n    localTimeRange,\n    setTimeRange,\n    refresh,\n    localRefreshInterval,\n    refreshCounter,\n    refreshIntervalInMs,\n    setRefreshInterval,\n  ]);\n\n  return <TimeRangeContext.Provider value={ctx}>{children}</TimeRangeContext.Provider>;\n}\n"],"names":["React","createContext","useCallback","useContext","useEffect","useMemo","useState","isRelativeTimeRange","toAbsoluteTimeRange","getSuggestedStepMs","getRefreshIntervalInMs","TimeRangeContext","undefined","useTimeRangeContext","ctx","Error","useTimeRange","useSuggestedStepMs","width","absoluteTimeRange","TimeRangeProvider","props","timeRange","refreshInterval","children","setTimeRange","setRefreshInterval","localTimeRange","setLocalTimeRange","localRefreshInterval","setLocalRefreshInterval","refreshCounter","setRefreshCounter","refresh","counter","refreshIntervalInMs","interval","setInterval","clearInterval","refreshKey","start","end","Provider","value"],"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,OAAOA,SAASC,aAAa,EAAgBC,WAAW,EAAEC,UAAU,EAAEC,SAAS,EAAEC,OAAO,EAAEC,QAAQ,QAAQ,QAAQ;AAClH,SAIEC,mBAAmB,EACnBC,mBAAmB,EACnBC,kBAAkB,QACb,mBAAmB;AAC1B,SAASC,sBAAsB,QAAQ,qBAAqB;AAqB5D,OAAO,MAAMC,iCAAmBV,cAAqCW,WAAW;AAEhF,OAAO,SAASC;IACd,MAAMC,MAAMX,WAAWQ;IACvB,IAAIG,QAAQF,WAAW;QACrB,MAAM,IAAIG,MAAM;IAClB;IACA,OAAOD;AACT;AAEA;;CAEC,GACD,OAAO,SAASE;IACd,OAAOH;AACT;AAEA;;CAEC,GACD,OAAO,SAASI,mBAAmBC,KAAc;IAC/C,MAAM,EAAEC,iBAAiB,EAAE,GAAGH;IAC9B,IAAIE,UAAUN,WAAW,OAAO;IAChC,OAAOH,mBAAmBU,mBAAmBD;AAC/C;AAEA;;CAEC,GACD,OAAO,SAASE,kBAAkBC,KAA6B;IAC7D,MAAM,EAAEC,SAAS,EAAEC,eAAe,EAAEC,QAAQ,EAAEC,YAAY,EAAEC,kBAAkB,EAAE,GAAGL;IAEnF;;;;;GAKC,GAED,MAAM,CAACM,gBAAgBC,kBAAkB,GAAGtB,SAAyBgB;IACrE,MAAM,CAACO,sBAAsBC,wBAAwB,GAAGxB,SAAqCiB;IAE7F,MAAM,CAACQ,gBAAgBC,kBAAkB,GAAG1B,SAAS;IAErDF,UAAU;QACRwB,kBAAkBN;IACpB,GAAG;QAACA;QAAWS;KAAe;IAE9B3B,UAAU;QACR0B,wBAAwBP;IAC1B,GAAG;QAACA;KAAgB;IAEpB,MAAMU,UAAU/B,YAAY;QAC1B8B,kBAAkB,CAACE,UAAYA,UAAU;IAC3C,GAAG;QAACF;KAAkB;IAEtB,MAAMG,sBAAsBzB,uBAAuBmB;IACnDzB,UAAU;QACR,IAAI+B,sBAAsB,GAAG;YAC3B,MAAMC,WAAWC,YAAY;gBAC3BJ;YACF,GAAGE;YAEH,OAAO,IAAYG,cAAcF;QACnC;IACF,GAAG;QAACH;QAASE;KAAoB;IAEjC,MAAMrB,MAAMT,QAAQ;QAClB,MAAMc,oBAAoBZ,oBAAoBoB,kBAC1CnB,oBAAoBmB,kBACpBA;QACJ,OAAO;YACLL,WAAWK;YACXF,cAAcA,gBAAgBG;YAC9BT;YACAc;YACAM,YAAY,GAAGpB,kBAAkBqB,KAAK,CAAC,CAAC,EAAErB,kBAAkBsB,GAAG,CAAC,CAAC,EAAEZ,qBAAqB,CAAC,EAAEE,gBAAgB;YAC3GR,iBAAiBM;YACjBM,qBAAqBA;YACrBT,oBAAoBA,sBAAsBI;QAC5C;IACF,GAAG;QACDH;QACAF;QACAQ;QACAJ;QACAE;QACAI;QACAT;KACD;IAED,qBAAO,KAACf,iBAAiB+B,QAAQ;QAACC,OAAO7B;kBAAMU;;AACjD"}

package/dist/runtime/TimeRangeProvider/query-params.d.ts

@@ -1,20 +1,15 @@
-import { QueryParamConfig } from 'use-query-params';
 import { TimeRangeValue, DurationString } from '@perses-dev/core';
 import { TimeRange } from './TimeRangeProvider';
 export type TimeOptionValue = Date | DurationString | null | undefined;
-export declare function encodeTimeRangeValue(timeOptionValue: TimeOptionValue): string | null | undefined;
+export declare function encodeTimeRangeValue(timeOptionValue: TimeOptionValue): string;
 export declare function decodeTimeRangeValue(input: string | Array<string | null> | null | undefined): Date | DurationString | null | undefined;
-/**
- * Custom TimeRangeValue param type
- * See: https://github.com/pbeshai/use-query-params/tree/master/packages/serialize-query-params#param-types
- */
-export declare const TimeRangeParam: QueryParamConfig<TimeOptionValue, TimeOptionValue>;
-export declare const timeRangeQueryConfig: {
-    start: QueryParamConfig<TimeOptionValue, TimeOptionValue>;
-    end: QueryParamConfig<TimeOptionValue, TimeOptionValue>;
+export declare const parseAsTimeRangeValue: import("nuqs").ParserBuilder<TimeOptionValue>;
+export declare const parseAsTimeRange: {
+    start: import("nuqs").ParserBuilder<TimeOptionValue>;
+    end: import("nuqs").ParserBuilder<TimeOptionValue>;
 };
-export declare const refreshIntervalQueryConfig: {
-    refresh: QueryParamConfig<TimeOptionValue, TimeOptionValue>;
+export declare const parseAsRefreshInterval: {
+    refresh: import("nuqs").ParserBuilder<TimeOptionValue>;
 };
 /**
  * Gets the initial time range taking into account URL params and dashboard JSON duration

package/dist/runtime/TimeRangeProvider/query-params.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../../../src/runtime/TimeRangeProvider/query-params.ts"],"names":[],"mappings":"AAcA,OAAO,EAAkB,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpE,OAAO,EACL,cAAc,EAGd,cAAc,EAEf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,cAAc,GAAG,IAAI,GAAG,SAAS,CAAC;AAwBvE,wBAAgB,oBAAoB,CAAC,eAAe,EAAE,eAAe,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAWhG;AAGD,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,GACtD,IAAI,GAAG,cAAc,GAAG,IAAI,GAAG,SAAS,CAI1C;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,gBAAgB,CAAC,eAAe,EAAE,eAAe,CAQ7E,CAAC;AAEF,eAAO,MAAM,oBAAoB;;;CAGhC,CAAC;AAEF,eAAO,MAAM,0BAA0B;;CAEtC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,iBAAiB,EAAE,cAAc,GAAG,cAAc,CAgBrF;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,gBAAgB,EAAE,cAAc,GAAG,IAAI,CAAC,SAAS,EAAE,WAAW,GAAG,cAAc,CAAC,CA8BlH;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,iBAAiB,EAAE,cAAc,GAAG,cAAc,CAc3F;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,sBAAsB,CAAC,EAAE,cAAc,GACtC,IAAI,CAAC,SAAS,EAAE,iBAAiB,GAAG,oBAAoB,CAAC,CAyB3D"}
+{"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../../../src/runtime/TimeRangeProvider/query-params.ts"],"names":[],"mappings":"AAeA,OAAO,EACL,cAAc,EAGd,cAAc,EAEf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,cAAc,GAAG,IAAI,GAAG,SAAS,CAAC;AAwBvE,wBAAgB,oBAAoB,CAAC,eAAe,EAAE,eAAe,GAAG,MAAM,CAW7E;AAGD,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,GACtD,IAAI,GAAG,cAAc,GAAG,IAAI,GAAG,SAAS,CAI1C;AAED,eAAO,MAAM,qBAAqB,+CAQhC,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;CAG5B,CAAC;AAEF,eAAO,MAAM,sBAAsB;;CAElC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,iBAAiB,EAAE,cAAc,GAAG,cAAc,CAiBrF;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,gBAAgB,EAAE,cAAc,GAAG,IAAI,CAAC,SAAS,EAAE,WAAW,GAAG,cAAc,CAAC,CA6BlH;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,iBAAiB,EAAE,cAAc,GAAG,cAAc,CAc3F;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,sBAAsB,CAAC,EAAE,cAAc,GACtC,IAAI,CAAC,SAAS,EAAE,iBAAiB,GAAG,oBAAoB,CAAC,CAyB3D"}

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

@@ -11,9 +11,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { useMemo, useCallback, useEffect, useState } from 'react';
-import { useQueryParams } from 'use-query-params';
 import { getUnixTime, isDate } from 'date-fns';
 import { isRelativeTimeRange, isDurationString } from '@perses-dev/core';
+import { createParser, useQueryStates } from 'nuqs';
 /* Interprets an encoded string and returns either the string or null/undefined if not available */ function getEncodedValue(input, allowEmptyString) {
     // '' or []
     if (!input || input.length === 0 && (!allowEmptyString || allowEmptyString && input !== '')) {
@@ -30,7 +30,7 @@ import { isRelativeTimeRange, isDurationString } from '@perses-dev/core';
 }
 /* Encodes individual TimeRangeValue as a string, depends on whether start is relative or absolute */ export function encodeTimeRangeValue(timeOptionValue) {
     if (!timeOptionValue) {
-        return timeOptionValue;
+        return '';
     }
     if (typeof timeOptionValue === 'string') {
         if (isDurationString(timeOptionValue)) {
@@ -44,31 +44,28 @@ import { isRelativeTimeRange, isDurationString } from '@perses-dev/core';
     if (!paramString) return null;
     return isDurationString(paramString) ? paramString : new Date(Number(paramString));
 }
-/**
- * Custom TimeRangeValue param type
- * See: https://github.com/pbeshai/use-query-params/tree/master/packages/serialize-query-params#param-types
- */ export const TimeRangeParam = {
-    encode: encodeTimeRangeValue,
-    decode: decodeTimeRangeValue,
-    equals: (valueA, valueB)=>{
+export const parseAsTimeRangeValue = createParser({
+    parse: decodeTimeRangeValue,
+    serialize: encodeTimeRangeValue,
+    eq: (valueA, valueB)=>{
         if (valueA === valueB) return true;
         if (!valueA || !valueB) return valueA === valueB;
         return valueA.valueOf() === valueB.valueOf();
     }
+});
+export const parseAsTimeRange = {
+    start: parseAsTimeRangeValue,
+    end: parseAsTimeRangeValue
 };
-export const timeRangeQueryConfig = {
-    start: TimeRangeParam,
-    end: TimeRangeParam
-};
-export const refreshIntervalQueryConfig = {
-    refresh: TimeRangeParam
+export const parseAsRefreshInterval = {
+    refresh: parseAsTimeRangeValue
 };
 /**
  * Gets the initial time range taking into account URL params and dashboard JSON duration
  * Sets start query param if it is empty on page load
  */ export function useInitialTimeRange(dashboardDuration) {
-    const [query] = useQueryParams(timeRangeQueryConfig, {
-        updateType: 'replaceIn'
+    const [query] = useQueryStates(parseAsTimeRange, {
+        history: 'replace'
     });
     const { start, end } = query;
     return useMemo(()=>{
@@ -99,8 +96,8 @@ export const refreshIntervalQueryConfig = {
 /**
  * Returns time range getter and setter, taking the URL query params.
  */ export function useTimeRangeParams(initialTimeRange) {
-    const [query, setQuery] = useQueryParams(timeRangeQueryConfig, {
-        updateType: 'replaceIn'
+    const [query, setQuery] = useQueryStates(parseAsTimeRange, {
+        history: 'replace'
     });
     // determine whether initial param had previously been populated to fix back btn
     const [paramsLoaded, setParamsLoaded] = useState(false);
@@ -143,8 +140,8 @@ export const refreshIntervalQueryConfig = {
  * Gets the initial refresh interval taking into account URL params and dashboard JSON duration
  * Sets refresh query param if it is empty on page load
  */ export function useInitialRefreshInterval(dashboardDuration) {
-    const [query] = useQueryParams(refreshIntervalQueryConfig, {
-        updateType: 'replaceIn'
+    const [query] = useQueryStates(parseAsRefreshInterval, {
+        history: 'replace'
     });
     const { refresh } = query;
     return useMemo(()=>{
@@ -165,8 +162,8 @@ export const refreshIntervalQueryConfig = {
 /**
  * Returns refresh interval getter and setter, taking the URL query params.
  */ export function useSetRefreshIntervalParams(initialRefreshInterval) {
-    const [query, setQuery] = useQueryParams(refreshIntervalQueryConfig, {
-        updateType: 'replaceIn'
+    const [query, setQuery] = useQueryStates(parseAsRefreshInterval, {
+        history: 'replace'
     });
     // determine whether initial param had previously been populated to fix back btn
     const [paramsLoaded, setParamsLoaded] = useState(false);

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/runtime/TimeRangeProvider/query-params.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { useMemo, useCallback, useEffect, useState } from 'react';\nimport { useQueryParams, QueryParamConfig } from 'use-query-params';\nimport { getUnixTime, isDate } from 'date-fns';\nimport {\n  TimeRangeValue,\n  isRelativeTimeRange,\n  isDurationString,\n  DurationString,\n  AbsoluteTimeRange,\n} from '@perses-dev/core';\nimport { TimeRange } from './TimeRangeProvider';\n\nexport type TimeOptionValue = Date | DurationString | null | undefined;\n\n/* Interprets an encoded string and returns either the string or null/undefined if not available */\nfunction getEncodedValue(\n  input: string | Array<string | null> | null | undefined,\n  allowEmptyString?: boolean\n): string | null | undefined {\n  // '' or []\n  if (!input || (input.length === 0 && (!allowEmptyString || (allowEmptyString && input !== '')))) {\n    return null;\n  }\n\n  const str = input instanceof Array ? input[0] : input;\n  if (str === null || str === undefined) {\n    return str;\n  }\n  if (!allowEmptyString && str === '') {\n    return null;\n  }\n\n  return str;\n}\n\n/* Encodes individual TimeRangeValue as a string, depends on whether start is relative or absolute */\nexport function encodeTimeRangeValue(timeOptionValue: TimeOptionValue): string | null | undefined {\n  if (!timeOptionValue) {\n    return timeOptionValue;\n  }\n\n  if (typeof timeOptionValue === 'string') {\n    if (isDurationString(timeOptionValue)) {\n      return timeOptionValue;\n    }\n  }\n  return (getUnixTime(timeOptionValue) * 1000).toString();\n}\n\n/* Converts param input to supported relative or absolute time range format */\nexport function decodeTimeRangeValue(\n  input: string | Array<string | null> | null | undefined\n): Date | DurationString | null | undefined {\n  const paramString = getEncodedValue(input);\n  if (!paramString) return null;\n  return isDurationString(paramString) ? paramString : new Date(Number(paramString));\n}\n\n/**\n * Custom TimeRangeValue param type\n * See: https://github.com/pbeshai/use-query-params/tree/master/packages/serialize-query-params#param-types\n */\nexport const TimeRangeParam: QueryParamConfig<TimeOptionValue, TimeOptionValue> = {\n  encode: encodeTimeRangeValue,\n  decode: decodeTimeRangeValue,\n  equals: (valueA: TimeOptionValue, valueB: TimeOptionValue) => {\n    if (valueA === valueB) return true;\n    if (!valueA || !valueB) return valueA === valueB;\n    return valueA.valueOf() === valueB.valueOf();\n  },\n};\n\nexport const timeRangeQueryConfig = {\n  start: TimeRangeParam,\n  end: TimeRangeParam,\n};\n\nexport const refreshIntervalQueryConfig = {\n  refresh: TimeRangeParam,\n};\n\n/**\n * Gets the initial time range taking into account URL params and dashboard JSON duration\n * Sets start query param if it is empty on page load\n */\nexport function useInitialTimeRange(dashboardDuration: DurationString): TimeRangeValue {\n  const [query] = useQueryParams(timeRangeQueryConfig, { updateType: 'replaceIn' });\n  const { start, end } = query;\n  return useMemo(() => {\n    let initialTimeRange: TimeRangeValue = { pastDuration: dashboardDuration };\n    if (!start) {\n      return initialTimeRange;\n    }\n    const startStr = start.toString();\n    if (isDurationString(startStr)) {\n      initialTimeRange = { pastDuration: startStr };\n    } else if (isDate(start) && isDate(end)) {\n      initialTimeRange = { start: start, end: end } as AbsoluteTimeRange;\n    }\n    return initialTimeRange;\n  }, [start, end, dashboardDuration]);\n}\n\n/**\n * Returns time range getter and setter, taking the URL query params.\n */\nexport function useTimeRangeParams(initialTimeRange: TimeRangeValue): Pick<TimeRange, 'timeRange' | 'setTimeRange'> {\n  const [query, setQuery] = useQueryParams(timeRangeQueryConfig, { updateType: 'replaceIn' });\n\n  // determine whether initial param had previously been populated to fix back btn\n  const [paramsLoaded, setParamsLoaded] = useState<boolean>(false);\n\n  const { start } = query;\n\n  useEffect(() => {\n    // when dashboard loaded with no params, default to dashboard duration\n    if (!paramsLoaded && !start) {\n      if (isRelativeTimeRange(initialTimeRange)) {\n        setQuery({ start: initialTimeRange.pastDuration, end: undefined });\n        setParamsLoaded(true);\n      }\n    }\n  }, [initialTimeRange, paramsLoaded, start, setQuery]);\n\n  const setTimeRange: TimeRange['setTimeRange'] = useCallback(\n    (value: TimeRangeValue) => {\n      if (isRelativeTimeRange(value)) {\n        setQuery({ start: value.pastDuration, end: undefined });\n      } else {\n        setQuery(value);\n      }\n    },\n    [setQuery]\n  );\n\n  return { timeRange: initialTimeRange, setTimeRange: setTimeRange };\n}\n\n/**\n * Gets the initial refresh interval taking into account URL params and dashboard JSON duration\n * Sets refresh query param if it is empty on page load\n */\nexport function useInitialRefreshInterval(dashboardDuration: DurationString): DurationString {\n  const [query] = useQueryParams(refreshIntervalQueryConfig, { updateType: 'replaceIn' });\n  const { refresh } = query;\n  return useMemo(() => {\n    let initialTimeRange: DurationString = dashboardDuration;\n    if (!refresh) {\n      return initialTimeRange;\n    }\n    const startStr = refresh.toString();\n    if (isDurationString(startStr)) {\n      initialTimeRange = startStr;\n    }\n    return initialTimeRange;\n  }, [dashboardDuration, refresh]);\n}\n\n/**\n * Returns refresh interval getter and setter, taking the URL query params.\n */\nexport function useSetRefreshIntervalParams(\n  initialRefreshInterval?: DurationString\n): Pick<TimeRange, 'refreshInterval' | 'setRefreshInterval'> {\n  const [query, setQuery] = useQueryParams(refreshIntervalQueryConfig, { updateType: 'replaceIn' });\n\n  // determine whether initial param had previously been populated to fix back btn\n  const [paramsLoaded, setParamsLoaded] = useState<boolean>(false);\n\n  const { refresh } = query;\n\n  useEffect(() => {\n    // when dashboard loaded with no params, default to dashboard refresh interval\n    if (!paramsLoaded && !refresh) {\n      setQuery({ refresh: initialRefreshInterval });\n      setParamsLoaded(true);\n    }\n  }, [initialRefreshInterval, paramsLoaded, refresh, setQuery]);\n\n  const setRefreshInterval: TimeRange['setRefreshInterval'] = useCallback(\n    (refresh: DurationString) => setQuery({ refresh }),\n    [setQuery]\n  );\n\n  return {\n    refreshInterval: initialRefreshInterval,\n    setRefreshInterval: setRefreshInterval,\n  };\n}\n"],"names":["useMemo","useCallback","useEffect","useState","useQueryParams","getUnixTime","isDate","isRelativeTimeRange","isDurationString","getEncodedValue","input","allowEmptyString","length","str","Array","undefined","encodeTimeRangeValue","timeOptionValue","toString","decodeTimeRangeValue","paramString","Date","Number","TimeRangeParam","encode","decode","equals","valueA","valueB","valueOf","timeRangeQueryConfig","start","end","refreshIntervalQueryConfig","refresh","useInitialTimeRange","dashboardDuration","query","updateType","initialTimeRange","pastDuration","startStr","useTimeRangeParams","setQuery","paramsLoaded","setParamsLoaded","setTimeRange","value","timeRange","useInitialRefreshInterval","useSetRefreshIntervalParams","initialRefreshInterval","setRefreshInterval","refreshInterval"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SAASA,OAAO,EAAEC,WAAW,EAAEC,SAAS,EAAEC,QAAQ,QAAQ,QAAQ;AAClE,SAASC,cAAc,QAA0B,mBAAmB;AACpE,SAASC,WAAW,EAAEC,MAAM,QAAQ,WAAW;AAC/C,SAEEC,mBAAmB,EACnBC,gBAAgB,QAGX,mBAAmB;AAK1B,iGAAiG,GACjG,SAASC,gBACPC,KAAuD,EACvDC,gBAA0B;IAE1B,WAAW;IACX,IAAI,CAACD,SAAUA,MAAME,MAAM,KAAK,KAAM,CAAA,CAACD,oBAAqBA,oBAAoBD,UAAU,EAAE,GAAK;QAC/F,OAAO;IACT;IAEA,MAAMG,MAAMH,iBAAiBI,QAAQJ,KAAK,CAAC,EAAE,GAAGA;IAChD,IAAIG,QAAQ,QAAQA,QAAQE,WAAW;QACrC,OAAOF;IACT;IACA,IAAI,CAACF,oBAAoBE,QAAQ,IAAI;QACnC,OAAO;IACT;IAEA,OAAOA;AACT;AAEA,mGAAmG,GACnG,OAAO,SAASG,qBAAqBC,eAAgC;IACnE,IAAI,CAACA,iBAAiB;QACpB,OAAOA;IACT;IAEA,IAAI,OAAOA,oBAAoB,UAAU;QACvC,IAAIT,iBAAiBS,kBAAkB;YACrC,OAAOA;QACT;IACF;IACA,OAAO,AAACZ,CAAAA,YAAYY,mBAAmB,IAAG,EAAGC,QAAQ;AACvD;AAEA,4EAA4E,GAC5E,OAAO,SAASC,qBACdT,KAAuD;IAEvD,MAAMU,cAAcX,gBAAgBC;IACpC,IAAI,CAACU,aAAa,OAAO;IACzB,OAAOZ,iBAAiBY,eAAeA,cAAc,IAAIC,KAAKC,OAAOF;AACvE;AAEA;;;CAGC,GACD,OAAO,MAAMG,iBAAqE;IAChFC,QAAQR;IACRS,QAAQN;IACRO,QAAQ,CAACC,QAAyBC;QAChC,IAAID,WAAWC,QAAQ,OAAO;QAC9B,IAAI,CAACD,UAAU,CAACC,QAAQ,OAAOD,WAAWC;QAC1C,OAAOD,OAAOE,OAAO,OAAOD,OAAOC,OAAO;IAC5C;AACF,EAAE;AAEF,OAAO,MAAMC,uBAAuB;IAClCC,OAAOR;IACPS,KAAKT;AACP,EAAE;AAEF,OAAO,MAAMU,6BAA6B;IACxCC,SAASX;AACX,EAAE;AAEF;;;CAGC,GACD,OAAO,SAASY,oBAAoBC,iBAAiC;IACnE,MAAM,CAACC,MAAM,GAAGjC,eAAe0B,sBAAsB;QAAEQ,YAAY;IAAY;IAC/E,MAAM,EAAEP,KAAK,EAAEC,GAAG,EAAE,GAAGK;IACvB,OAAOrC,QAAQ;QACb,IAAIuC,mBAAmC;YAAEC,cAAcJ;QAAkB;QACzE,IAAI,CAACL,OAAO;YACV,OAAOQ;QACT;QACA,MAAME,WAAWV,MAAMb,QAAQ;QAC/B,IAAIV,iBAAiBiC,WAAW;YAC9BF,mBAAmB;gBAAEC,cAAcC;YAAS;QAC9C,OAAO,IAAInC,OAAOyB,UAAUzB,OAAO0B,MAAM;YACvCO,mBAAmB;gBAAER,OAAOA;gBAAOC,KAAKA;YAAI;QAC9C;QACA,OAAOO;IACT,GAAG;QAACR;QAAOC;QAAKI;KAAkB;AACpC;AAEA;;CAEC,GACD,OAAO,SAASM,mBAAmBH,gBAAgC;IACjE,MAAM,CAACF,OAAOM,SAAS,GAAGvC,eAAe0B,sBAAsB;QAAEQ,YAAY;IAAY;IAEzF,gFAAgF;IAChF,MAAM,CAACM,cAAcC,gBAAgB,GAAG1C,SAAkB;IAE1D,MAAM,EAAE4B,KAAK,EAAE,GAAGM;IAElBnC,UAAU;QACR,sEAAsE;QACtE,IAAI,CAAC0C,gBAAgB,CAACb,OAAO;YAC3B,IAAIxB,oBAAoBgC,mBAAmB;gBACzCI,SAAS;oBAAEZ,OAAOQ,iBAAiBC,YAAY;oBAAER,KAAKjB;gBAAU;gBAChE8B,gBAAgB;YAClB;QACF;IACF,GAAG;QAACN;QAAkBK;QAAcb;QAAOY;KAAS;IAEpD,MAAMG,eAA0C7C,YAC9C,CAAC8C;QACC,IAAIxC,oBAAoBwC,QAAQ;YAC9BJ,SAAS;gBAAEZ,OAAOgB,MAAMP,YAAY;gBAAER,KAAKjB;YAAU;QACvD,OAAO;YACL4B,SAASI;QACX;IACF,GACA;QAACJ;KAAS;IAGZ,OAAO;QAAEK,WAAWT;QAAkBO,cAAcA;IAAa;AACnE;AAEA;;;CAGC,GACD,OAAO,SAASG,0BAA0Bb,iBAAiC;IACzE,MAAM,CAACC,MAAM,GAAGjC,eAAe6B,4BAA4B;QAAEK,YAAY;IAAY;IACrF,MAAM,EAAEJ,OAAO,EAAE,GAAGG;IACpB,OAAOrC,QAAQ;QACb,IAAIuC,mBAAmCH;QACvC,IAAI,CAACF,SAAS;YACZ,OAAOK;QACT;QACA,MAAME,WAAWP,QAAQhB,QAAQ;QACjC,IAAIV,iBAAiBiC,WAAW;YAC9BF,mBAAmBE;QACrB;QACA,OAAOF;IACT,GAAG;QAACH;QAAmBF;KAAQ;AACjC;AAEA;;CAEC,GACD,OAAO,SAASgB,4BACdC,sBAAuC;IAEvC,MAAM,CAACd,OAAOM,SAAS,GAAGvC,eAAe6B,4BAA4B;QAAEK,YAAY;IAAY;IAE/F,gFAAgF;IAChF,MAAM,CAACM,cAAcC,gBAAgB,GAAG1C,SAAkB;IAE1D,MAAM,EAAE+B,OAAO,EAAE,GAAGG;IAEpBnC,UAAU;QACR,8EAA8E;QAC9E,IAAI,CAAC0C,gBAAgB,CAACV,SAAS;YAC7BS,SAAS;gBAAET,SAASiB;YAAuB;YAC3CN,gBAAgB;QAClB;IACF,GAAG;QAACM;QAAwBP;QAAcV;QAASS;KAAS;IAE5D,MAAMS,qBAAsDnD,YAC1D,CAACiC,UAA4BS,SAAS;YAAET;QAAQ,IAChD;QAACS;KAAS;IAGZ,OAAO;QACLU,iBAAiBF;QACjBC,oBAAoBA;IACtB;AACF"}
+{"version":3,"sources":["../../../src/runtime/TimeRangeProvider/query-params.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { useMemo, useCallback, useEffect, useState } from 'react';\nimport { getUnixTime, isDate } from 'date-fns';\nimport {\n  TimeRangeValue,\n  isRelativeTimeRange,\n  isDurationString,\n  DurationString,\n  AbsoluteTimeRange,\n} from '@perses-dev/core';\nimport { createParser, useQueryStates } from 'nuqs';\nimport { TimeRange } from './TimeRangeProvider';\n\nexport type TimeOptionValue = Date | DurationString | null | undefined;\n\n/* Interprets an encoded string and returns either the string or null/undefined if not available */\nfunction getEncodedValue(\n  input: string | Array<string | null> | null | undefined,\n  allowEmptyString?: boolean\n): string | null | undefined {\n  // '' or []\n  if (!input || (input.length === 0 && (!allowEmptyString || (allowEmptyString && input !== '')))) {\n    return null;\n  }\n\n  const str = input instanceof Array ? input[0] : input;\n  if (str === null || str === undefined) {\n    return str;\n  }\n  if (!allowEmptyString && str === '') {\n    return null;\n  }\n\n  return str;\n}\n\n/* Encodes individual TimeRangeValue as a string, depends on whether start is relative or absolute */\nexport function encodeTimeRangeValue(timeOptionValue: TimeOptionValue): string {\n  if (!timeOptionValue) {\n    return '';\n  }\n\n  if (typeof timeOptionValue === 'string') {\n    if (isDurationString(timeOptionValue)) {\n      return timeOptionValue;\n    }\n  }\n  return (getUnixTime(timeOptionValue) * 1000).toString();\n}\n\n/* Converts param input to supported relative or absolute time range format */\nexport function decodeTimeRangeValue(\n  input: string | Array<string | null> | null | undefined\n): Date | DurationString | null | undefined {\n  const paramString = getEncodedValue(input);\n  if (!paramString) return null;\n  return isDurationString(paramString) ? paramString : new Date(Number(paramString));\n}\n\nexport const parseAsTimeRangeValue = createParser<TimeOptionValue>({\n  parse: decodeTimeRangeValue,\n  serialize: encodeTimeRangeValue,\n  eq: (valueA: TimeOptionValue, valueB: TimeOptionValue) => {\n    if (valueA === valueB) return true;\n    if (!valueA || !valueB) return valueA === valueB;\n    return valueA.valueOf() === valueB.valueOf();\n  },\n});\n\nexport const parseAsTimeRange = {\n  start: parseAsTimeRangeValue,\n  end: parseAsTimeRangeValue,\n};\n\nexport const parseAsRefreshInterval = {\n  refresh: parseAsTimeRangeValue,\n};\n\n/**\n * Gets the initial time range taking into account URL params and dashboard JSON duration\n * Sets start query param if it is empty on page load\n */\nexport function useInitialTimeRange(dashboardDuration: DurationString): TimeRangeValue {\n  const [query] = useQueryStates(parseAsTimeRange, { history: 'replace' });\n  const { start, end } = query;\n\n  return useMemo(() => {\n    let initialTimeRange: TimeRangeValue = { pastDuration: dashboardDuration };\n    if (!start) {\n      return initialTimeRange;\n    }\n    const startStr = start.toString();\n    if (isDurationString(startStr)) {\n      initialTimeRange = { pastDuration: startStr };\n    } else if (isDate(start) && isDate(end)) {\n      initialTimeRange = { start: start, end: end } as AbsoluteTimeRange;\n    }\n    return initialTimeRange;\n  }, [start, end, dashboardDuration]);\n}\n\n/**\n * Returns time range getter and setter, taking the URL query params.\n */\nexport function useTimeRangeParams(initialTimeRange: TimeRangeValue): Pick<TimeRange, 'timeRange' | 'setTimeRange'> {\n  const [query, setQuery] = useQueryStates(parseAsTimeRange, { history: 'replace' });\n  // determine whether initial param had previously been populated to fix back btn\n  const [paramsLoaded, setParamsLoaded] = useState<boolean>(false);\n\n  const { start } = query;\n\n  useEffect(() => {\n    // when dashboard loaded with no params, default to dashboard duration\n    if (!paramsLoaded && !start) {\n      if (isRelativeTimeRange(initialTimeRange)) {\n        setQuery({ start: initialTimeRange.pastDuration, end: undefined });\n        setParamsLoaded(true);\n      }\n    }\n  }, [initialTimeRange, paramsLoaded, start, setQuery]);\n\n  const setTimeRange: TimeRange['setTimeRange'] = useCallback(\n    (value: TimeRangeValue) => {\n      if (isRelativeTimeRange(value)) {\n        setQuery({ start: value.pastDuration, end: undefined });\n      } else {\n        setQuery(value);\n      }\n    },\n    [setQuery]\n  );\n\n  return { timeRange: initialTimeRange, setTimeRange: setTimeRange };\n}\n\n/**\n * Gets the initial refresh interval taking into account URL params and dashboard JSON duration\n * Sets refresh query param if it is empty on page load\n */\nexport function useInitialRefreshInterval(dashboardDuration: DurationString): DurationString {\n  const [query] = useQueryStates(parseAsRefreshInterval, { history: 'replace' });\n  const { refresh } = query;\n  return useMemo(() => {\n    let initialTimeRange: DurationString = dashboardDuration;\n    if (!refresh) {\n      return initialTimeRange;\n    }\n    const startStr = refresh.toString();\n    if (isDurationString(startStr)) {\n      initialTimeRange = startStr;\n    }\n    return initialTimeRange;\n  }, [dashboardDuration, refresh]);\n}\n\n/**\n * Returns refresh interval getter and setter, taking the URL query params.\n */\nexport function useSetRefreshIntervalParams(\n  initialRefreshInterval?: DurationString\n): Pick<TimeRange, 'refreshInterval' | 'setRefreshInterval'> {\n  const [query, setQuery] = useQueryStates(parseAsRefreshInterval, { history: 'replace' });\n\n  // determine whether initial param had previously been populated to fix back btn\n  const [paramsLoaded, setParamsLoaded] = useState<boolean>(false);\n\n  const { refresh } = query;\n\n  useEffect(() => {\n    // when dashboard loaded with no params, default to dashboard refresh interval\n    if (!paramsLoaded && !refresh) {\n      setQuery({ refresh: initialRefreshInterval });\n      setParamsLoaded(true);\n    }\n  }, [initialRefreshInterval, paramsLoaded, refresh, setQuery]);\n\n  const setRefreshInterval: TimeRange['setRefreshInterval'] = useCallback(\n    (refresh: DurationString) => setQuery({ refresh }),\n    [setQuery]\n  );\n\n  return {\n    refreshInterval: initialRefreshInterval,\n    setRefreshInterval: setRefreshInterval,\n  };\n}\n"],"names":["useMemo","useCallback","useEffect","useState","getUnixTime","isDate","isRelativeTimeRange","isDurationString","createParser","useQueryStates","getEncodedValue","input","allowEmptyString","length","str","Array","undefined","encodeTimeRangeValue","timeOptionValue","toString","decodeTimeRangeValue","paramString","Date","Number","parseAsTimeRangeValue","parse","serialize","eq","valueA","valueB","valueOf","parseAsTimeRange","start","end","parseAsRefreshInterval","refresh","useInitialTimeRange","dashboardDuration","query","history","initialTimeRange","pastDuration","startStr","useTimeRangeParams","setQuery","paramsLoaded","setParamsLoaded","setTimeRange","value","timeRange","useInitialRefreshInterval","useSetRefreshIntervalParams","initialRefreshInterval","setRefreshInterval","refreshInterval"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SAASA,OAAO,EAAEC,WAAW,EAAEC,SAAS,EAAEC,QAAQ,QAAQ,QAAQ;AAClE,SAASC,WAAW,EAAEC,MAAM,QAAQ,WAAW;AAC/C,SAEEC,mBAAmB,EACnBC,gBAAgB,QAGX,mBAAmB;AAC1B,SAASC,YAAY,EAAEC,cAAc,QAAQ,OAAO;AAKpD,iGAAiG,GACjG,SAASC,gBACPC,KAAuD,EACvDC,gBAA0B;IAE1B,WAAW;IACX,IAAI,CAACD,SAAUA,MAAME,MAAM,KAAK,KAAM,CAAA,CAACD,oBAAqBA,oBAAoBD,UAAU,EAAE,GAAK;QAC/F,OAAO;IACT;IAEA,MAAMG,MAAMH,iBAAiBI,QAAQJ,KAAK,CAAC,EAAE,GAAGA;IAChD,IAAIG,QAAQ,QAAQA,QAAQE,WAAW;QACrC,OAAOF;IACT;IACA,IAAI,CAACF,oBAAoBE,QAAQ,IAAI;QACnC,OAAO;IACT;IAEA,OAAOA;AACT;AAEA,mGAAmG,GACnG,OAAO,SAASG,qBAAqBC,eAAgC;IACnE,IAAI,CAACA,iBAAiB;QACpB,OAAO;IACT;IAEA,IAAI,OAAOA,oBAAoB,UAAU;QACvC,IAAIX,iBAAiBW,kBAAkB;YACrC,OAAOA;QACT;IACF;IACA,OAAO,AAACd,CAAAA,YAAYc,mBAAmB,IAAG,EAAGC,QAAQ;AACvD;AAEA,4EAA4E,GAC5E,OAAO,SAASC,qBACdT,KAAuD;IAEvD,MAAMU,cAAcX,gBAAgBC;IACpC,IAAI,CAACU,aAAa,OAAO;IACzB,OAAOd,iBAAiBc,eAAeA,cAAc,IAAIC,KAAKC,OAAOF;AACvE;AAEA,OAAO,MAAMG,wBAAwBhB,aAA8B;IACjEiB,OAAOL;IACPM,WAAWT;IACXU,IAAI,CAACC,QAAyBC;QAC5B,IAAID,WAAWC,QAAQ,OAAO;QAC9B,IAAI,CAACD,UAAU,CAACC,QAAQ,OAAOD,WAAWC;QAC1C,OAAOD,OAAOE,OAAO,OAAOD,OAAOC,OAAO;IAC5C;AACF,GAAG;AAEH,OAAO,MAAMC,mBAAmB;IAC9BC,OAAOR;IACPS,KAAKT;AACP,EAAE;AAEF,OAAO,MAAMU,yBAAyB;IACpCC,SAASX;AACX,EAAE;AAEF;;;CAGC,GACD,OAAO,SAASY,oBAAoBC,iBAAiC;IACnE,MAAM,CAACC,MAAM,GAAG7B,eAAesB,kBAAkB;QAAEQ,SAAS;IAAU;IACtE,MAAM,EAAEP,KAAK,EAAEC,GAAG,EAAE,GAAGK;IAEvB,OAAOtC,QAAQ;QACb,IAAIwC,mBAAmC;YAAEC,cAAcJ;QAAkB;QACzE,IAAI,CAACL,OAAO;YACV,OAAOQ;QACT;QACA,MAAME,WAAWV,MAAMb,QAAQ;QAC/B,IAAIZ,iBAAiBmC,WAAW;YAC9BF,mBAAmB;gBAAEC,cAAcC;YAAS;QAC9C,OAAO,IAAIrC,OAAO2B,UAAU3B,OAAO4B,MAAM;YACvCO,mBAAmB;gBAAER,OAAOA;gBAAOC,KAAKA;YAAI;QAC9C;QACA,OAAOO;IACT,GAAG;QAACR;QAAOC;QAAKI;KAAkB;AACpC;AAEA;;CAEC,GACD,OAAO,SAASM,mBAAmBH,gBAAgC;IACjE,MAAM,CAACF,OAAOM,SAAS,GAAGnC,eAAesB,kBAAkB;QAAEQ,SAAS;IAAU;IAChF,gFAAgF;IAChF,MAAM,CAACM,cAAcC,gBAAgB,GAAG3C,SAAkB;IAE1D,MAAM,EAAE6B,KAAK,EAAE,GAAGM;IAElBpC,UAAU;QACR,sEAAsE;QACtE,IAAI,CAAC2C,gBAAgB,CAACb,OAAO;YAC3B,IAAI1B,oBAAoBkC,mBAAmB;gBACzCI,SAAS;oBAAEZ,OAAOQ,iBAAiBC,YAAY;oBAAER,KAAKjB;gBAAU;gBAChE8B,gBAAgB;YAClB;QACF;IACF,GAAG;QAACN;QAAkBK;QAAcb;QAAOY;KAAS;IAEpD,MAAMG,eAA0C9C,YAC9C,CAAC+C;QACC,IAAI1C,oBAAoB0C,QAAQ;YAC9BJ,SAAS;gBAAEZ,OAAOgB,MAAMP,YAAY;gBAAER,KAAKjB;YAAU;QACvD,OAAO;YACL4B,SAASI;QACX;IACF,GACA;QAACJ;KAAS;IAGZ,OAAO;QAAEK,WAAWT;QAAkBO,cAAcA;IAAa;AACnE;AAEA;;;CAGC,GACD,OAAO,SAASG,0BAA0Bb,iBAAiC;IACzE,MAAM,CAACC,MAAM,GAAG7B,eAAeyB,wBAAwB;QAAEK,SAAS;IAAU;IAC5E,MAAM,EAAEJ,OAAO,EAAE,GAAGG;IACpB,OAAOtC,QAAQ;QACb,IAAIwC,mBAAmCH;QACvC,IAAI,CAACF,SAAS;YACZ,OAAOK;QACT;QACA,MAAME,WAAWP,QAAQhB,QAAQ;QACjC,IAAIZ,iBAAiBmC,WAAW;YAC9BF,mBAAmBE;QACrB;QACA,OAAOF;IACT,GAAG;QAACH;QAAmBF;KAAQ;AACjC;AAEA;;CAEC,GACD,OAAO,SAASgB,4BACdC,sBAAuC;IAEvC,MAAM,CAACd,OAAOM,SAAS,GAAGnC,eAAeyB,wBAAwB;QAAEK,SAAS;IAAU;IAEtF,gFAAgF;IAChF,MAAM,CAACM,cAAcC,gBAAgB,GAAG3C,SAAkB;IAE1D,MAAM,EAAEgC,OAAO,EAAE,GAAGG;IAEpBpC,UAAU;QACR,8EAA8E;QAC9E,IAAI,CAAC2C,gBAAgB,CAACV,SAAS;YAC7BS,SAAS;gBAAET,SAASiB;YAAuB;YAC3CN,gBAAgB;QAClB;IACF,GAAG;QAACM;QAAwBP;QAAcV;QAASS;KAAS;IAE5D,MAAMS,qBAAsDpD,YAC1D,CAACkC,UAA4BS,SAAS;YAAET;QAAQ,IAChD;QAACS;KAAS;IAGZ,OAAO;QACLU,iBAAiBF;QACjBC,oBAAoBA;IACtB;AACF"}

package/dist/test/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/test/utils.tsx"],"names":[],"mappings":"AAcA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAG9C,MAAM,MAAM,cAAc,GAAG;IAC3B,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC;AAEF,wBAAgB,qBAAqB,CAAC,cAAc,CAAC,EAAE,cAAc,kBAM7B;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,KAAG,SAAS,CAgB1E"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/test/utils.tsx"],"names":[],"mappings":"AAcA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGlC,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAI9C,MAAM,MAAM,cAAc,GAAG;IAC3B,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC;AAEF,wBAAgB,qBAAqB,CAAC,cAAc,CAAC,EAAE,cAAc,kBAO7B;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,KAAG,SAAS,CAkB1E"}

package/dist/test/utils.js

@@ -12,7 +12,9 @@
 // limitations under the License.
 import { jsx as _jsx } from "react/jsx-runtime";
 import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+import { DEFAULT_DASHBOARD_DURATION } from '@perses-dev/core';
 import { PluginRegistry } from '../components';
+import { TimeRangeProvider } from '../runtime';
 import { testPluginLoader } from './test-plugins';
 export function getTestContextWrapper(contextOptions) {
     // Create a new QueryClient for each test to avoid caching issues
@@ -24,15 +26,22 @@ export function getTestContextWrapper(contextOptions) {
             }
         }
     });
+    const timeRange = {
+        start: new Date(Date.now() - Number(DEFAULT_DASHBOARD_DURATION)),
+        end: new Date()
+    };
     return function Wrapper({ children }) {
-        return /*#__PURE__*/ _jsx(QueryClientProvider, {
-            client: queryClient,
-            children: /*#__PURE__*/ _jsx(PluginRegistry, {
-                pluginLoader: testPluginLoader,
-                defaultPluginKinds: contextOptions?.defaultPluginKinds ?? {
-                    TimeSeriesQuery: 'PrometheusTimeSeriesQuery'
-                },
-                children: children
+        return /*#__PURE__*/ _jsx(TimeRangeProvider, {
+            timeRange: timeRange,
+            children: /*#__PURE__*/ _jsx(QueryClientProvider, {
+                client: queryClient,
+                children: /*#__PURE__*/ _jsx(PluginRegistry, {
+                    pluginLoader: testPluginLoader,
+                    defaultPluginKinds: contextOptions?.defaultPluginKinds ?? {
+                        TimeSeriesQuery: 'PrometheusTimeSeriesQuery'
+                    },
+                    children: children
+                })
             })
         });
     };

package/dist/test/utils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/test/utils.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 { QueryClient, QueryClientProvider } from '@tanstack/react-query';\nimport { ReactNode } from 'react';\nimport { PluginRegistry } from '../components';\nimport { DefaultPluginKinds } from '../model';\nimport { testPluginLoader } from './test-plugins';\n\nexport type ContextOptions = {\n  defaultPluginKinds?: DefaultPluginKinds;\n};\n\nexport function getTestContextWrapper(contextOptions?: ContextOptions) {\n  // Create a new QueryClient for each test to avoid caching issues\n  const queryClient = new QueryClient({\n    defaultOptions: { queries: { refetchOnWindowFocus: false, retry: false } },\n  });\n\n  return function Wrapper({ children }: { children: ReactNode }): ReactNode {\n    return (\n      <QueryClientProvider client={queryClient}>\n        <PluginRegistry\n          pluginLoader={testPluginLoader}\n          defaultPluginKinds={\n            contextOptions?.defaultPluginKinds ?? {\n              TimeSeriesQuery: 'PrometheusTimeSeriesQuery',\n            }\n          }\n        >\n          {children}\n        </PluginRegistry>\n      </QueryClientProvider>\n    );\n  };\n}\n"],"names":["QueryClient","QueryClientProvider","PluginRegistry","testPluginLoader","getTestContextWrapper","contextOptions","queryClient","defaultOptions","queries","refetchOnWindowFocus","retry","Wrapper","children","client","pluginLoader","defaultPluginKinds","TimeSeriesQuery"],"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,WAAW,EAAEC,mBAAmB,QAAQ,wBAAwB;AAEzE,SAASC,cAAc,QAAQ,gBAAgB;AAE/C,SAASC,gBAAgB,QAAQ,iBAAiB;AAMlD,OAAO,SAASC,sBAAsBC,cAA+B;IACnE,iEAAiE;IACjE,MAAMC,cAAc,IAAIN,YAAY;QAClCO,gBAAgB;YAAEC,SAAS;gBAAEC,sBAAsB;gBAAOC,OAAO;YAAM;QAAE;IAC3E;IAEA,OAAO,SAASC,QAAQ,EAAEC,QAAQ,EAA2B;QAC3D,qBACE,KAACX;YAAoBY,QAAQP;sBAC3B,cAAA,KAACJ;gBACCY,cAAcX;gBACdY,oBACEV,gBAAgBU,sBAAsB;oBACpCC,iBAAiB;gBACnB;0BAGDJ;;;IAIT;AACF"}
+{"version":3,"sources":["../../src/test/utils.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 { QueryClient, QueryClientProvider } from '@tanstack/react-query';\nimport { ReactNode } from 'react';\nimport { DEFAULT_DASHBOARD_DURATION } from '@perses-dev/core';\nimport { PluginRegistry } from '../components';\nimport { DefaultPluginKinds } from '../model';\nimport { TimeRangeProvider } from '../runtime';\nimport { testPluginLoader } from './test-plugins';\n\nexport type ContextOptions = {\n  defaultPluginKinds?: DefaultPluginKinds;\n};\n\nexport function getTestContextWrapper(contextOptions?: ContextOptions) {\n  // Create a new QueryClient for each test to avoid caching issues\n  const queryClient = new QueryClient({\n    defaultOptions: { queries: { refetchOnWindowFocus: false, retry: false } },\n  });\n\n  const timeRange = { start: new Date(Date.now() - Number(DEFAULT_DASHBOARD_DURATION)), end: new Date() };\n  return function Wrapper({ children }: { children: ReactNode }): ReactNode {\n    return (\n      <TimeRangeProvider timeRange={timeRange}>\n        <QueryClientProvider client={queryClient}>\n          <PluginRegistry\n            pluginLoader={testPluginLoader}\n            defaultPluginKinds={\n              contextOptions?.defaultPluginKinds ?? {\n                TimeSeriesQuery: 'PrometheusTimeSeriesQuery',\n              }\n            }\n          >\n            {children}\n          </PluginRegistry>\n        </QueryClientProvider>\n      </TimeRangeProvider>\n    );\n  };\n}\n"],"names":["QueryClient","QueryClientProvider","DEFAULT_DASHBOARD_DURATION","PluginRegistry","TimeRangeProvider","testPluginLoader","getTestContextWrapper","contextOptions","queryClient","defaultOptions","queries","refetchOnWindowFocus","retry","timeRange","start","Date","now","Number","end","Wrapper","children","client","pluginLoader","defaultPluginKinds","TimeSeriesQuery"],"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,WAAW,EAAEC,mBAAmB,QAAQ,wBAAwB;AAEzE,SAASC,0BAA0B,QAAQ,mBAAmB;AAC9D,SAASC,cAAc,QAAQ,gBAAgB;AAE/C,SAASC,iBAAiB,QAAQ,aAAa;AAC/C,SAASC,gBAAgB,QAAQ,iBAAiB;AAMlD,OAAO,SAASC,sBAAsBC,cAA+B;IACnE,iEAAiE;IACjE,MAAMC,cAAc,IAAIR,YAAY;QAClCS,gBAAgB;YAAEC,SAAS;gBAAEC,sBAAsB;gBAAOC,OAAO;YAAM;QAAE;IAC3E;IAEA,MAAMC,YAAY;QAAEC,OAAO,IAAIC,KAAKA,KAAKC,GAAG,KAAKC,OAAOf;QAA8BgB,KAAK,IAAIH;IAAO;IACtG,OAAO,SAASI,QAAQ,EAAEC,QAAQ,EAA2B;QAC3D,qBACE,KAAChB;YAAkBS,WAAWA;sBAC5B,cAAA,KAACZ;gBAAoBoB,QAAQb;0BAC3B,cAAA,KAACL;oBACCmB,cAAcjB;oBACdkB,oBACEhB,gBAAgBgB,sBAAsB;wBACpCC,iBAAiB;oBACnB;8BAGDJ;;;;IAKX;AACF"}

package/dist/utils/variables.d.ts

@@ -1,9 +1,31 @@
 import { VariableValue } from '@perses-dev/core';
 import { VariableStateMap } from '@perses-dev/plugin-system';
 export declare function replaceVariables(text: string, variableState: VariableStateMap): string;
-export declare function replaceVariable(text: string, varName: string, variableValue: VariableValue): string;
+export declare enum InterpolationFormat {
+    CSV = "csv",
+    DISTRIBUTED = "distributed",
+    DOUBLEQUOTE = "doublequote",
+    GLOB = "glob",
+    JSON = "json",
+    LUCENE = "lucene",
+    PERCENTENCODE = "percentencode",
+    PIPE = "pipe",
+    PROMETHEUS = "prometheus",
+    RAW = "raw",
+    REGEX = "regex",
+    SINGLEQUOTE = "singlequote",
+    SQLSTRING = "sqlstring",
+    TEXT = "text",
+    QUERYPARAM = "queryparam"
+}
+export declare function interpolate(values: string[], name: string, format: InterpolationFormat): string;
+export declare function replaceVariable(text: string, varName: string, variableValue: VariableValue, varFormat?: InterpolationFormat): string;
 /**
  * Returns a list of variables
  */
-export declare const parseVariables: (text: string) => string[];
+export declare function parseVariables(text: string): string[];
+/**
+ * Returns a map of variable names and its format. If no format is specified, it will be undefined.
+ */
+export declare function parseVariablesAndFormat(text: string): Map<string, InterpolationFormat | undefined>;
 //# sourceMappingURL=variables.d.ts.map

package/dist/utils/variables.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../src/utils/variables.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE7D,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,gBAAgB,GAAG,MAAM,CAgBtF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,GAAG,MAAM,CAcnG;AAWD;;GAEG;AACH,eAAO,MAAM,cAAc,SAAU,MAAM,KAAG,MAAM,EAkBnD,CAAC"}
+{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../src/utils/variables.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE7D,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,gBAAgB,GAAG,MAAM,CAiBtF;AAED,oBAAY,mBAAmB;IAC7B,GAAG,QAAQ;IACX,WAAW,gBAAgB;IAC3B,WAAW,gBAAgB;IAC3B,IAAI,SAAS;IACb,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,aAAa,kBAAkB;IAC/B,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,UAAU,eAAe;CAC1B;AASD,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,MAAM,CAqC/F;AAED,wBAAgB,eAAe,CAC7B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,aAAa,EAC5B,SAAS,CAAC,EAAE,mBAAmB,GAC9B,MAAM,CAcR;AAUD;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAiBrD;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,mBAAmB,GAAG,SAAS,CAAC,CAoBlG"}

package/dist/utils/variables.js

@@ -11,7 +11,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 export function replaceVariables(text, variableState) {
-    const variables = parseVariables(text);
+    const variablesMap = parseVariablesAndFormat(text);
+    const variables = Array.from(variablesMap.keys());
     let finalText = text;
     variables// Sorting variables by their length.
     // In order to not have a variable name have contained in another variable name.
@@ -19,20 +20,88 @@ export function replaceVariables(text, variableState) {
     .sort((a, b)=>b.length - a.length).forEach((v)=>{
         const variable = variableState[v];
         if (variable && variable.value !== undefined) {
-            finalText = replaceVariable(finalText, v, variable?.value);
+            finalText = replaceVariable(finalText, v, variable?.value, variablesMap.get(v));
         }
     });
     return finalText;
 }
-export function replaceVariable(text, varName, variableValue) {
+export var InterpolationFormat = /*#__PURE__*/ function(InterpolationFormat) {
+    InterpolationFormat["CSV"] = "csv";
+    InterpolationFormat["DISTRIBUTED"] = "distributed";
+    InterpolationFormat["DOUBLEQUOTE"] = "doublequote";
+    InterpolationFormat["GLOB"] = "glob";
+    InterpolationFormat["JSON"] = "json";
+    InterpolationFormat["LUCENE"] = "lucene";
+    InterpolationFormat["PERCENTENCODE"] = "percentencode";
+    InterpolationFormat["PIPE"] = "pipe";
+    InterpolationFormat["PROMETHEUS"] = "prometheus";
+    InterpolationFormat["RAW"] = "raw";
+    InterpolationFormat["REGEX"] = "regex";
+    InterpolationFormat["SINGLEQUOTE"] = "singlequote";
+    InterpolationFormat["SQLSTRING"] = "sqlstring";
+    InterpolationFormat["TEXT"] = "text";
+    InterpolationFormat["QUERYPARAM"] = "queryparam";
+    return InterpolationFormat;
+}({});
+function stringToFormat(val) {
+    if (!val) return undefined;
+    const lowerVal = val.toLowerCase();
+    return Object.values(InterpolationFormat).find((format)=>format === lowerVal) || undefined;
+}
+export function interpolate(values, name, format) {
+    switch(format){
+        case "csv":
+        case "raw":
+            return values.join(',');
+        case "distributed":
+            {
+                const [first, ...rest] = values;
+                return `${[
+                    first,
+                    ...rest.map((v)=>`${name}=${v}`)
+                ].join(',')}`;
+            }
+        case "doublequote":
+            return values.map((v)=>`"${v}"`).join(',');
+        case "glob":
+            return `{${values.join(',')}}`;
+        case "json":
+            return JSON.stringify(values);
+        case "lucene":
+            return `(${values.map((v)=>`"${v}"`).join(' OR ')})`;
+        case "percentencode":
+            return encodeURIComponent(values.join(','));
+        case "pipe":
+            return values.join('|');
+        case "regex":
+            {
+                const escapedRegex = values.map((v)=>v.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&'));
+                return `(${escapedRegex.join('|')})`;
+            }
+        case "singlequote":
+            return values.map((v)=>`'${v}'`).join(',');
+        case "sqlstring":
+            return values.map((v)=>`'${v.replace(/'/g, "''")}'`).join(',');
+        case "text":
+            return values.join(' + ');
+        case "queryparam":
+            return values.map((v)=>`${name}=${encodeURIComponent(v)}`).join('&');
+        case "prometheus":
+        default:
+            return `(${values.join('|')})`;
+    }
+}
+export function replaceVariable(text, varName, variableValue, varFormat) {
     const variableSyntax = '$' + varName;
-    const alternativeVariableSyntax = '${' + varName + '}';
+    const alternativeVariableSyntax = '${' + varName + (varFormat ? ':' + varFormat : '') + '}';
     let replaceString = '';
     if (Array.isArray(variableValue)) {
-        replaceString = `(${variableValue.join('|')})`; // regex style
+        replaceString = interpolate(variableValue, varName, varFormat || "prometheus");
     }
     if (typeof variableValue === 'string') {
-        replaceString = variableValue;
+        replaceString = interpolate([
+            variableValue
+        ], varName, varFormat || "raw");
     }
     text = text.replaceAll(variableSyntax, replaceString);
     return text.replaceAll(alternativeVariableSyntax, replaceString);
@@ -41,17 +110,14 @@ export function replaceVariable(text, varName, variableValue) {
 // It supports two formats for referencing variables:
 // 1. $variableName - This is a simpler format, and the regular expression captures the variable name (\w+ matches one or more word characters).
 // 2. ${variableName} - This is a more complex format and the regular expression captures the variable name (\w+ matches one or more word characters) in the curly braces.
-// 3. [COMING SOON] ${variableName:value} - This is a more complex format that allows specifying a format function as well.
-// TODO: Fix this lint error
-// eslint-disable-next-line no-useless-escape
-const VARIABLE_REGEX = /\$(\w+)|\${(\w+)(?:\.([^:^\}]+))?(?::([^\}]+))?}/gm;
+// 3. ${variableName:format} - This is a more complex format that allows specifying a format interpolation.
+const VARIABLE_REGEX = /\$(\w+)|\${(\w+)(?:\.([^:^}]+))?(?::([^}]+))?}/gm;
 /**
  * Returns a list of variables
- */ export const parseVariables = (text)=>{
-    const regex = VARIABLE_REGEX;
+ */ export function parseVariables(text) {
     const matches = new Set();
     let match;
-    while((match = regex.exec(text)) !== null){
+    while((match = VARIABLE_REGEX.exec(text)) !== null){
         if (match) {
             if (match[1]) {
                 // \$(\w+)\
@@ -64,6 +130,28 @@ const VARIABLE_REGEX = /\$(\w+)|\${(\w+)(?:\.([^:^\}]+))?(?::([^\}]+))?}/gm;
     }
     // return unique matches
     return Array.from(matches.values());
-};
+}
+/**
+ * Returns a map of variable names and its format. If no format is specified, it will be undefined.
+ */ export function parseVariablesAndFormat(text) {
+    const matches = new Map();
+    let match;
+    while((match = VARIABLE_REGEX.exec(text)) !== null){
+        if (match) {
+            let format = undefined;
+            if (match[4]) {
+                format = match[4];
+            }
+            if (match[1]) {
+                // \$(\w+)\
+                matches.set(match[1], stringToFormat(format));
+            } else if (match[2]) {
+                // \${(\w+)}\
+                matches.set(match[2], stringToFormat(format));
+            }
+        }
+    }
+    return matches;
+}
 
 //# sourceMappingURL=variables.js.map