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

package/dist/utils/variables.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/variables.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 { VariableValue } from '@perses-dev/core';\nimport { VariableStateMap } from '@perses-dev/plugin-system';\n\nexport function replaceVariables(text: string, variableState: VariableStateMap): string {\n  const variables = parseVariables(text);\n  let finalText = text;\n  variables\n    // Sorting variables by their length.\n    // In order to not have a variable name have contained in another variable name.\n    // i.e.: $__range replacing $__range_ms => '3600_ms' instead of '3600000'\n    .sort((a, b) => b.length - a.length)\n    .forEach((v) => {\n      const variable = variableState[v];\n      if (variable && variable.value !== undefined) {\n        finalText = replaceVariable(finalText, v, variable?.value);\n      }\n    });\n\n  return finalText;\n}\n\nexport function replaceVariable(text: string, varName: string, variableValue: VariableValue): string {\n  const variableSyntax = '$' + varName;\n  const alternativeVariableSyntax = '${' + varName + '}';\n\n  let replaceString = '';\n  if (Array.isArray(variableValue)) {\n    replaceString = `(${variableValue.join('|')})`; // regex style\n  }\n  if (typeof variableValue === 'string') {\n    replaceString = variableValue;\n  }\n\n  text = text.replaceAll(variableSyntax, replaceString);\n  return text.replaceAll(alternativeVariableSyntax, replaceString);\n}\n\n// This regular expression is designed to identify variable references in a string.\n// It supports two formats for referencing variables:\n// 1. $variableName - This is a simpler format, and the regular expression captures the variable name (\\w+ matches one or more word characters).\n// 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.\n// 3. [COMING SOON] ${variableName:value} - This is a more complex format that allows specifying a format function as well.\n// TODO: Fix this lint error\n// eslint-disable-next-line no-useless-escape\nconst VARIABLE_REGEX = /\\$(\\w+)|\\${(\\w+)(?:\\.([^:^\\}]+))?(?::([^\\}]+))?}/gm;\n\n/**\n * Returns a list of variables\n */\nexport const parseVariables = (text: string): string[] => {\n  const regex = VARIABLE_REGEX;\n  const matches = new Set<string>();\n  let match;\n\n  while ((match = regex.exec(text)) !== null) {\n    if (match) {\n      if (match[1]) {\n        // \\$(\\w+)\\\n        matches.add(match[1]);\n      } else if (match[2]) {\n        // \\${(\\w+)}\\\n        matches.add(match[2]);\n      }\n    }\n  }\n  // return unique matches\n  return Array.from(matches.values());\n};\n"],"names":["replaceVariables","text","variableState","variables","parseVariables","finalText","sort","a","b","length","forEach","v","variable","value","undefined","replaceVariable","varName","variableValue","variableSyntax","alternativeVariableSyntax","replaceString","Array","isArray","join","replaceAll","VARIABLE_REGEX","regex","matches","Set","match","exec","add","from","values"],"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;AAKjC,OAAO,SAASA,iBAAiBC,IAAY,EAAEC,aAA+B;IAC5E,MAAMC,YAAYC,eAAeH;IACjC,IAAII,YAAYJ;IAChBE,SACE,qCAAqC;IACrC,gFAAgF;IAChF,yEAAyE;KACxEG,IAAI,CAAC,CAACC,GAAGC,IAAMA,EAAEC,MAAM,GAAGF,EAAEE,MAAM,EAClCC,OAAO,CAAC,CAACC;QACR,MAAMC,WAAWV,aAAa,CAACS,EAAE;QACjC,IAAIC,YAAYA,SAASC,KAAK,KAAKC,WAAW;YAC5CT,YAAYU,gBAAgBV,WAAWM,GAAGC,UAAUC;QACtD;IACF;IAEF,OAAOR;AACT;AAEA,OAAO,SAASU,gBAAgBd,IAAY,EAAEe,OAAe,EAAEC,aAA4B;IACzF,MAAMC,iBAAiB,MAAMF;IAC7B,MAAMG,4BAA4B,OAAOH,UAAU;IAEnD,IAAII,gBAAgB;IACpB,IAAIC,MAAMC,OAAO,CAACL,gBAAgB;QAChCG,gBAAgB,CAAC,CAAC,EAAEH,cAAcM,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc;IAChE;IACA,IAAI,OAAON,kBAAkB,UAAU;QACrCG,gBAAgBH;IAClB;IAEAhB,OAAOA,KAAKuB,UAAU,CAACN,gBAAgBE;IACvC,OAAOnB,KAAKuB,UAAU,CAACL,2BAA2BC;AACpD;AAEA,mFAAmF;AACnF,qDAAqD;AACrD,gJAAgJ;AAChJ,0KAA0K;AAC1K,2HAA2H;AAC3H,4BAA4B;AAC5B,6CAA6C;AAC7C,MAAMK,iBAAiB;AAEvB;;CAEC,GACD,OAAO,MAAMrB,iBAAiB,CAACH;IAC7B,MAAMyB,QAAQD;IACd,MAAME,UAAU,IAAIC;IACpB,IAAIC;IAEJ,MAAO,AAACA,CAAAA,QAAQH,MAAMI,IAAI,CAAC7B,KAAI,MAAO,KAAM;QAC1C,IAAI4B,OAAO;YACT,IAAIA,KAAK,CAAC,EAAE,EAAE;gBACZ,WAAW;gBACXF,QAAQI,GAAG,CAACF,KAAK,CAAC,EAAE;YACtB,OAAO,IAAIA,KAAK,CAAC,EAAE,EAAE;gBACnB,aAAa;gBACbF,QAAQI,GAAG,CAACF,KAAK,CAAC,EAAE;YACtB;QACF;IACF;IACA,wBAAwB;IACxB,OAAOR,MAAMW,IAAI,CAACL,QAAQM,MAAM;AAClC,EAAE"}
+{"version":3,"sources":["../../src/utils/variables.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 { VariableValue } from '@perses-dev/core';\nimport { VariableStateMap } from '@perses-dev/plugin-system';\n\nexport function replaceVariables(text: string, variableState: VariableStateMap): string {\n  const variablesMap = parseVariablesAndFormat(text);\n  const variables = Array.from(variablesMap.keys());\n  let finalText = text;\n  variables\n    // Sorting variables by their length.\n    // In order to not have a variable name have contained in another variable name.\n    // i.e.: $__range replacing $__range_ms => '3600_ms' instead of '3600000'\n    .sort((a, b) => b.length - a.length)\n    .forEach((v) => {\n      const variable = variableState[v];\n      if (variable && variable.value !== undefined) {\n        finalText = replaceVariable(finalText, v, variable?.value, variablesMap.get(v));\n      }\n    });\n\n  return finalText;\n}\n\nexport enum InterpolationFormat {\n  CSV = 'csv',\n  DISTRIBUTED = 'distributed',\n  DOUBLEQUOTE = 'doublequote',\n  GLOB = 'glob',\n  JSON = 'json',\n  LUCENE = 'lucene',\n  PERCENTENCODE = 'percentencode',\n  PIPE = 'pipe',\n  PROMETHEUS = 'prometheus',\n  RAW = 'raw',\n  REGEX = 'regex',\n  SINGLEQUOTE = 'singlequote',\n  SQLSTRING = 'sqlstring',\n  TEXT = 'text',\n  QUERYPARAM = 'queryparam',\n}\n\nfunction stringToFormat(val: string | undefined): InterpolationFormat | undefined {\n  if (!val) return undefined;\n\n  const lowerVal = val.toLowerCase();\n  return Object.values(InterpolationFormat).find((format) => format === lowerVal) || undefined;\n}\n\nexport function interpolate(values: string[], name: string, format: InterpolationFormat): string {\n  switch (format) {\n    case InterpolationFormat.CSV:\n    case InterpolationFormat.RAW:\n      return values.join(',');\n    case InterpolationFormat.DISTRIBUTED: {\n      const [first, ...rest] = values;\n      return `${[first, ...rest.map((v) => `${name}=${v}`)].join(',')}`;\n    }\n    case InterpolationFormat.DOUBLEQUOTE:\n      return values.map((v) => `\"${v}\"`).join(',');\n    case InterpolationFormat.GLOB:\n      return `{${values.join(',')}}`;\n    case InterpolationFormat.JSON:\n      return JSON.stringify(values);\n    case InterpolationFormat.LUCENE:\n      return `(${values.map((v) => `\"${v}\"`).join(' OR ')})`;\n    case InterpolationFormat.PERCENTENCODE:\n      return encodeURIComponent(values.join(','));\n    case InterpolationFormat.PIPE:\n      return values.join('|');\n    case InterpolationFormat.REGEX: {\n      const escapedRegex = values.map((v) => v.replace(/[-/\\\\^$*+?.()|[\\]{}]/g, '\\\\$&'));\n      return `(${escapedRegex.join('|')})`;\n    }\n    case InterpolationFormat.SINGLEQUOTE:\n      return values.map((v) => `'${v}'`).join(',');\n    case InterpolationFormat.SQLSTRING:\n      return values.map((v) => `'${v.replace(/'/g, \"''\")}'`).join(',');\n    case InterpolationFormat.TEXT:\n      return values.join(' + ');\n    case InterpolationFormat.QUERYPARAM:\n      return values.map((v) => `${name}=${encodeURIComponent(v)}`).join('&');\n    case InterpolationFormat.PROMETHEUS:\n    default:\n      return `(${values.join('|')})`;\n  }\n}\n\nexport function replaceVariable(\n  text: string,\n  varName: string,\n  variableValue: VariableValue,\n  varFormat?: InterpolationFormat\n): string {\n  const variableSyntax = '$' + varName;\n  const alternativeVariableSyntax = '${' + varName + (varFormat ? ':' + varFormat : '') + '}';\n\n  let replaceString = '';\n  if (Array.isArray(variableValue)) {\n    replaceString = interpolate(variableValue, varName, varFormat || InterpolationFormat.PROMETHEUS);\n  }\n  if (typeof variableValue === 'string') {\n    replaceString = interpolate([variableValue], varName, varFormat || InterpolationFormat.RAW);\n  }\n\n  text = text.replaceAll(variableSyntax, replaceString);\n  return text.replaceAll(alternativeVariableSyntax, replaceString);\n}\n\n// This regular expression is designed to identify variable references in a string.\n// It supports two formats for referencing variables:\n// 1. $variableName - This is a simpler format, and the regular expression captures the variable name (\\w+ matches one or more word characters).\n// 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.\n// 3. ${variableName:format} - This is a more complex format that allows specifying a format interpolation.\n\nconst VARIABLE_REGEX = /\\$(\\w+)|\\${(\\w+)(?:\\.([^:^}]+))?(?::([^}]+))?}/gm;\n\n/**\n * Returns a list of variables\n */\nexport function parseVariables(text: string): string[] {\n  const matches = new Set<string>();\n  let match;\n\n  while ((match = VARIABLE_REGEX.exec(text)) !== null) {\n    if (match) {\n      if (match[1]) {\n        // \\$(\\w+)\\\n        matches.add(match[1]);\n      } else if (match[2]) {\n        // \\${(\\w+)}\\\n        matches.add(match[2]);\n      }\n    }\n  }\n  // return unique matches\n  return Array.from(matches.values());\n}\n\n/**\n * Returns a map of variable names and its format. If no format is specified, it will be undefined.\n */\nexport function parseVariablesAndFormat(text: string): Map<string, InterpolationFormat | undefined> {\n  const matches = new Map<string, InterpolationFormat | undefined>();\n  let match;\n\n  while ((match = VARIABLE_REGEX.exec(text)) !== null) {\n    if (match) {\n      let format = undefined;\n      if (match[4]) {\n        format = match[4];\n      }\n      if (match[1]) {\n        // \\$(\\w+)\\\n        matches.set(match[1], stringToFormat(format));\n      } else if (match[2]) {\n        // \\${(\\w+)}\\\n        matches.set(match[2], stringToFormat(format));\n      }\n    }\n  }\n  return matches;\n}\n"],"names":["replaceVariables","text","variableState","variablesMap","parseVariablesAndFormat","variables","Array","from","keys","finalText","sort","a","b","length","forEach","v","variable","value","undefined","replaceVariable","get","InterpolationFormat","stringToFormat","val","lowerVal","toLowerCase","Object","values","find","format","interpolate","name","join","first","rest","map","JSON","stringify","encodeURIComponent","escapedRegex","replace","varName","variableValue","varFormat","variableSyntax","alternativeVariableSyntax","replaceString","isArray","replaceAll","VARIABLE_REGEX","parseVariables","matches","Set","match","exec","add","Map","set"],"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;AAKjC,OAAO,SAASA,iBAAiBC,IAAY,EAAEC,aAA+B;IAC5E,MAAMC,eAAeC,wBAAwBH;IAC7C,MAAMI,YAAYC,MAAMC,IAAI,CAACJ,aAAaK,IAAI;IAC9C,IAAIC,YAAYR;IAChBI,SACE,qCAAqC;IACrC,gFAAgF;IAChF,yEAAyE;KACxEK,IAAI,CAAC,CAACC,GAAGC,IAAMA,EAAEC,MAAM,GAAGF,EAAEE,MAAM,EAClCC,OAAO,CAAC,CAACC;QACR,MAAMC,WAAWd,aAAa,CAACa,EAAE;QACjC,IAAIC,YAAYA,SAASC,KAAK,KAAKC,WAAW;YAC5CT,YAAYU,gBAAgBV,WAAWM,GAAGC,UAAUC,OAAOd,aAAaiB,GAAG,CAACL;QAC9E;IACF;IAEF,OAAON;AACT;AAEA,OAAO,IAAA,AAAKY,6CAAAA;;;;;;;;;;;;;;;;WAAAA;MAgBX;AAED,SAASC,eAAeC,GAAuB;IAC7C,IAAI,CAACA,KAAK,OAAOL;IAEjB,MAAMM,WAAWD,IAAIE,WAAW;IAChC,OAAOC,OAAOC,MAAM,CAACN,qBAAqBO,IAAI,CAAC,CAACC,SAAWA,WAAWL,aAAaN;AACrF;AAEA,OAAO,SAASY,YAAYH,MAAgB,EAAEI,IAAY,EAAEF,MAA2B;IACrF,OAAQA;QACN;QACA;YACE,OAAOF,OAAOK,IAAI,CAAC;QACrB;YAAsC;gBACpC,MAAM,CAACC,OAAO,GAAGC,KAAK,GAAGP;gBACzB,OAAO,GAAG;oBAACM;uBAAUC,KAAKC,GAAG,CAAC,CAACpB,IAAM,GAAGgB,KAAK,CAAC,EAAEhB,GAAG;iBAAE,CAACiB,IAAI,CAAC,MAAM;YACnE;QACA;YACE,OAAOL,OAAOQ,GAAG,CAAC,CAACpB,IAAM,CAAC,CAAC,EAAEA,EAAE,CAAC,CAAC,EAAEiB,IAAI,CAAC;QAC1C;YACE,OAAO,CAAC,CAAC,EAAEL,OAAOK,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC;YACE,OAAOI,KAAKC,SAAS,CAACV;QACxB;YACE,OAAO,CAAC,CAAC,EAAEA,OAAOQ,GAAG,CAAC,CAACpB,IAAM,CAAC,CAAC,EAAEA,EAAE,CAAC,CAAC,EAAEiB,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxD;YACE,OAAOM,mBAAmBX,OAAOK,IAAI,CAAC;QACxC;YACE,OAAOL,OAAOK,IAAI,CAAC;QACrB;YAAgC;gBAC9B,MAAMO,eAAeZ,OAAOQ,GAAG,CAAC,CAACpB,IAAMA,EAAEyB,OAAO,CAAC,yBAAyB;gBAC1E,OAAO,CAAC,CAAC,EAAED,aAAaP,IAAI,CAAC,KAAK,CAAC,CAAC;YACtC;QACA;YACE,OAAOL,OAAOQ,GAAG,CAAC,CAACpB,IAAM,CAAC,CAAC,EAAEA,EAAE,CAAC,CAAC,EAAEiB,IAAI,CAAC;QAC1C;YACE,OAAOL,OAAOQ,GAAG,CAAC,CAACpB,IAAM,CAAC,CAAC,EAAEA,EAAEyB,OAAO,CAAC,MAAM,MAAM,CAAC,CAAC,EAAER,IAAI,CAAC;QAC9D;YACE,OAAOL,OAAOK,IAAI,CAAC;QACrB;YACE,OAAOL,OAAOQ,GAAG,CAAC,CAACpB,IAAM,GAAGgB,KAAK,CAAC,EAAEO,mBAAmBvB,IAAI,EAAEiB,IAAI,CAAC;QACpE;QACA;YACE,OAAO,CAAC,CAAC,EAAEL,OAAOK,IAAI,CAAC,KAAK,CAAC,CAAC;IAClC;AACF;AAEA,OAAO,SAASb,gBACdlB,IAAY,EACZwC,OAAe,EACfC,aAA4B,EAC5BC,SAA+B;IAE/B,MAAMC,iBAAiB,MAAMH;IAC7B,MAAMI,4BAA4B,OAAOJ,UAAWE,CAAAA,YAAY,MAAMA,YAAY,EAAC,IAAK;IAExF,IAAIG,gBAAgB;IACpB,IAAIxC,MAAMyC,OAAO,CAACL,gBAAgB;QAChCI,gBAAgBhB,YAAYY,eAAeD,SAASE;IACtD;IACA,IAAI,OAAOD,kBAAkB,UAAU;QACrCI,gBAAgBhB,YAAY;YAACY;SAAc,EAAED,SAASE;IACxD;IAEA1C,OAAOA,KAAK+C,UAAU,CAACJ,gBAAgBE;IACvC,OAAO7C,KAAK+C,UAAU,CAACH,2BAA2BC;AACpD;AAEA,mFAAmF;AACnF,qDAAqD;AACrD,gJAAgJ;AAChJ,0KAA0K;AAC1K,2GAA2G;AAE3G,MAAMG,iBAAiB;AAEvB;;CAEC,GACD,OAAO,SAASC,eAAejD,IAAY;IACzC,MAAMkD,UAAU,IAAIC;IACpB,IAAIC;IAEJ,MAAO,AAACA,CAAAA,QAAQJ,eAAeK,IAAI,CAACrD,KAAI,MAAO,KAAM;QACnD,IAAIoD,OAAO;YACT,IAAIA,KAAK,CAAC,EAAE,EAAE;gBACZ,WAAW;gBACXF,QAAQI,GAAG,CAACF,KAAK,CAAC,EAAE;YACtB,OAAO,IAAIA,KAAK,CAAC,EAAE,EAAE;gBACnB,aAAa;gBACbF,QAAQI,GAAG,CAACF,KAAK,CAAC,EAAE;YACtB;QACF;IACF;IACA,wBAAwB;IACxB,OAAO/C,MAAMC,IAAI,CAAC4C,QAAQxB,MAAM;AAClC;AAEA;;CAEC,GACD,OAAO,SAASvB,wBAAwBH,IAAY;IAClD,MAAMkD,UAAU,IAAIK;IACpB,IAAIH;IAEJ,MAAO,AAACA,CAAAA,QAAQJ,eAAeK,IAAI,CAACrD,KAAI,MAAO,KAAM;QACnD,IAAIoD,OAAO;YACT,IAAIxB,SAASX;YACb,IAAImC,KAAK,CAAC,EAAE,EAAE;gBACZxB,SAASwB,KAAK,CAAC,EAAE;YACnB;YACA,IAAIA,KAAK,CAAC,EAAE,EAAE;gBACZ,WAAW;gBACXF,QAAQM,GAAG,CAACJ,KAAK,CAAC,EAAE,EAAE/B,eAAeO;YACvC,OAAO,IAAIwB,KAAK,CAAC,EAAE,EAAE;gBACnB,aAAa;gBACbF,QAAQM,GAAG,CAACJ,KAAK,CAAC,EAAE,EAAE/B,eAAeO;YACvC;QACF;IACF;IACA,OAAOsB;AACT"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@perses-dev/plugin-system",
-  "version": "0.52.0-beta.5",
+  "version": "0.52.0-rc.1",
   "description": "The plugin feature in Pereses",
   "license": "Apache-2.0",
   "homepage": "https://github.com/perses/perses/blob/main/README.md",
@@ -29,14 +29,14 @@
   },
   "dependencies": {
     "@module-federation/enhanced": "^0.18.0",
-    "@perses-dev/components": "0.52.0-beta.5",
-    "@perses-dev/core": "0.52.0-beta.5",
+    "@perses-dev/components": "0.52.0-rc.1",
+    "@perses-dev/core": "0.52.0-rc.1",
     "date-fns": "^4.1.0",
     "date-fns-tz": "^3.2.0",
     "immer": "^10.1.1",
+    "nuqs": "^2.5.1",
     "react-hook-form": "^7.46.1",
     "use-immer": "^0.11.0",
-    "use-query-params": "^2.1.2",
     "zod": "^3.22.2"
   },
   "peerDependencies": {