@perses-dev/components 0.15.0 → 0.16.0

package/dist/model/units.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/model/units.ts"],"sourcesContent":["// Copyright 2022 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 { Duration, milliseconds } from 'date-fns';\nimport { round } from '../utils/mathjs';\n\nexport const DEFAULT_DECIMAL_PLACES = 2;\n\nexport type UnitOptions = TimeUnitOptions | PercentUnitOptions | DecimalUnitOptions | BytesUnitOptions;\n\nexport function formatValue(value: number, unitOptions?: UnitOptions): string {\n  if (unitOptions === undefined) {\n    return value.toString();\n  }\n\n  if (isDecimalUnit(unitOptions)) {\n    return formatDecimal(value, unitOptions);\n  }\n\n  if (isTimeUnit(unitOptions)) {\n    return formatTime(value, unitOptions);\n  }\n\n  if (isPercentUnit(unitOptions)) {\n    return formatPercent(value, unitOptions);\n  }\n\n  if (isBytesUnit(unitOptions)) {\n    const decimals = unitOptions.decimal_places ?? DEFAULT_DECIMAL_PLACES;\n    return formatBytes(value, decimals);\n  }\n\n  const exhaustive: never = unitOptions;\n  throw new Error(`Unknown unit options ${exhaustive}`);\n}\n\n/* Time Unit Conversion */\nconst timeUnitKinds = ['Milliseconds', 'Seconds', 'Minutes', 'Hours', 'Days', 'Weeks', 'Months', 'Years'] as const;\nconst timeUnitKindsSet = new Set<string>(timeUnitKinds);\n\ntype TimeUnitOptions = {\n  kind: typeof timeUnitKinds[number];\n};\n\nfunction isTimeUnit(unitOptions: UnitOptions): unitOptions is TimeUnitOptions {\n  return timeUnitKindsSet.has(unitOptions.kind);\n}\n\nfunction formatTime(value: number, unitOptions: TimeUnitOptions): string {\n  // Create a Duration from the value based on what time unit it is\n  const duration: Duration = {};\n  switch (unitOptions.kind) {\n    case 'Milliseconds':\n      duration.seconds = value / 1000;\n      break;\n    case 'Seconds':\n      duration.seconds = value;\n      break;\n    case 'Minutes':\n      duration.minutes = value;\n      break;\n    case 'Hours':\n      duration.hours = value;\n      break;\n    case 'Days':\n      duration.days = value;\n      break;\n    case 'Weeks':\n      duration.weeks = value;\n      break;\n    case 'Months':\n      duration.months = value;\n      break;\n    case 'Years':\n      duration.years = value;\n      break;\n    default: {\n      const exhaustive: never = unitOptions.kind;\n      throw new Error(`Unknown time unit type ${exhaustive}`);\n    }\n  }\n\n  // Find the largest whole time unit we can display the value in and use it\n  const ms = milliseconds(duration);\n  const seconds = ms / 1000;\n  if (seconds < 1) {\n    return `${ms.toFixed()} milliseconds`;\n  }\n\n  const minutes = seconds / 60;\n  if (minutes < 1) {\n    return `${seconds.toFixed()} seconds`;\n  }\n\n  const hours = minutes / 60;\n  if (hours < 1) {\n    return `${minutes.toFixed()} minutes`;\n  }\n\n  const days = hours / 24;\n  if (days < 1) {\n    return `${hours.toFixed()} hours`;\n  }\n\n  const weeks = days / 7;\n  if (weeks < 1) {\n    return `${days.toFixed()} days`;\n  }\n\n  const years = weeks / 52;\n  if (years < 1) {\n    return `${weeks.toFixed()} weeks`;\n  }\n\n  return `${years.toFixed()} years`;\n}\n\n/* Percent Unit Conversion */\nconst percentUnitKinds = ['Percent', 'PercentDecimal', '%'] as const;\nconst percentUnitKindsSet = new Set<string>(percentUnitKinds);\n\ntype PercentUnitOptions = {\n  kind: typeof percentUnitKinds[number];\n  decimal_places?: number;\n};\n\nfunction isPercentUnit(unitOptions: UnitOptions): unitOptions is PercentUnitOptions {\n  return percentUnitKindsSet.has(unitOptions.kind);\n}\n\nfunction formatPercent(value: number, unitOptions: PercentUnitOptions): string {\n  const decimals = unitOptions.decimal_places ?? DEFAULT_DECIMAL_PLACES;\n\n  if (unitOptions.kind === 'PercentDecimal') {\n    value = value * 100;\n  }\n\n  return value.toFixed(decimals) + '%';\n}\n\n/* Decimal Unit Conversion */\nconst decimalUnitKinds = ['Decimal'] as const;\nconst decimalUnitKindsSet = new Set<string>(decimalUnitKinds);\n\ntype DecimalUnitOptions = {\n  kind: typeof decimalUnitKinds[number];\n  decimal_places?: number;\n  abbreviate?: boolean;\n};\n\nfunction isDecimalUnit(unitOptions: UnitOptions): unitOptions is DecimalUnitOptions {\n  return decimalUnitKindsSet.has(unitOptions.kind);\n}\n\nfunction formatDecimal(value: number, unitOptions: DecimalUnitOptions): string {\n  const decimals = unitOptions.decimal_places ?? DEFAULT_DECIMAL_PLACES;\n\n  if (unitOptions.abbreviate === true) {\n    return abbreviateLargeNumber(value, decimals);\n  }\n\n  const formatParams: Intl.NumberFormatOptions = {\n    style: 'decimal',\n    minimumFractionDigits: 0,\n    maximumFractionDigits: decimals,\n    useGrouping: true,\n  };\n  const decimalFormatter = new Intl.NumberFormat('en-US', formatParams);\n  return decimalFormatter.format(value);\n}\n\n/**\n * Takes large numbers and abbreviates them with the appropriate suffix\n * 10123 -> 10.123k\n * 1000000 -> 1M\n */\nexport function abbreviateLargeNumber(num: number, decimals = 2) {\n  const modifier = (n: number) => round(n, decimals);\n  return formatNumber(num, modifier);\n}\n\n/**\n * Takes large numbers, rounds and abbreviates them with the appropriate suffix\n * Add modifier to run on output value prior to unit being added (defaults to rounding)\n */\nexport function formatNumber(num: number, modifier?: (n: number) => number): string {\n  const fn = modifier ?? Math.round;\n\n  return num >= 1e12\n    ? fn(num / 1e12) + 'T'\n    : num >= 1e9\n    ? fn(num / 1e9) + 'B'\n    : num >= 1e6\n    ? fn(num / 1e6) + 'M'\n    : num >= 1e3\n    ? fn(num / 1e3) + 'K'\n    : num.toString();\n}\n\n/* Bytes Unit Conversion */\nconst bytesUnitKinds = ['Bytes'] as const;\nconst bytesUnitKindsSet = new Set<string>(bytesUnitKinds);\n\ntype BytesUnitOptions = {\n  kind: typeof bytesUnitKinds[number];\n  decimal_places?: number;\n};\n\nfunction isBytesUnit(unitOptions: UnitOptions): unitOptions is BytesUnitOptions {\n  return bytesUnitKindsSet.has(unitOptions.kind);\n}\n\n// https://stackoverflow.com/questions/15900485/correct-way-to-convert-size-in-bytes-to-kb-mb-gb-in-javascript/18650828#18650828\nfunction formatBytes(bytes: number, decimals = 2) {\n  if (bytes === 0) return '0 Bytes';\n\n  const k = 1024;\n  const dm = decimals < 0 ? 0 : decimals;\n  const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];\n\n  // Math.max(0, ...) ensures that we don't return -1 as a value for the index.\n  // Why? When the number of bytes are between -1 and 1, Math.floor(Math.log(bytes)/Math.log(1024)) returns -1.\n  const i = Math.max(0, Math.floor(Math.log(bytes) / Math.log(k)));\n\n  return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i];\n}\n"],"names":["milliseconds","round","DEFAULT_DECIMAL_PLACES","formatValue","value","unitOptions","undefined","toString","isDecimalUnit","formatDecimal","isTimeUnit","formatTime","isPercentUnit","formatPercent","isBytesUnit","decimals","decimal_places","formatBytes","exhaustive","Error","timeUnitKinds","timeUnitKindsSet","Set","has","kind","duration","seconds","minutes","hours","days","weeks","months","years","ms","toFixed","percentUnitKinds","percentUnitKindsSet","decimalUnitKinds","decimalUnitKindsSet","abbreviate","abbreviateLargeNumber","formatParams","style","minimumFractionDigits","maximumFractionDigits","useGrouping","decimalFormatter","Intl","NumberFormat","format","num","modifier","n","formatNumber","fn","Math","bytesUnitKinds","bytesUnitKindsSet","bytes","k","dm","sizes","i","max","floor","log","parseFloat","pow"],"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,SAAmBA,YAAY,QAAQ,UAAU,CAAC;AAClD,SAASC,KAAK,QAAQ,iBAAiB,CAAC;AAExC,OAAO,MAAMC,sBAAsB,GAAG,CAAC,CAAC;AAIxC,OAAO,SAASC,WAAW,CAACC,KAAa,EAAEC,WAAyB,EAAU;IAC5E,IAAIA,WAAW,KAAKC,SAAS,EAAE;QAC7B,OAAOF,KAAK,CAACG,QAAQ,EAAE,CAAC;IAC1B,CAAC;IAED,IAAIC,aAAa,CAACH,WAAW,CAAC,EAAE;QAC9B,OAAOI,aAAa,CAACL,KAAK,EAAEC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,IAAIK,UAAU,CAACL,WAAW,CAAC,EAAE;QAC3B,OAAOM,UAAU,CAACP,KAAK,EAAEC,WAAW,CAAC,CAAC;IACxC,CAAC;IAED,IAAIO,aAAa,CAACP,WAAW,CAAC,EAAE;QAC9B,OAAOQ,aAAa,CAACT,KAAK,EAAEC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,IAAIS,WAAW,CAACT,WAAW,CAAC,EAAE;YACXA,eAA0B;QAA3C,MAAMU,QAAQ,GAAGV,CAAAA,eAA0B,GAA1BA,WAAW,CAACW,cAAc,cAA1BX,eAA0B,cAA1BA,eAA0B,GAAIH,sBAAsB,AAAC;QACtE,OAAOe,WAAW,CAACb,KAAK,EAAEW,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED,MAAMG,UAAU,GAAUb,WAAW,AAAC;IACtC,MAAM,IAAIc,KAAK,CAAC,CAAC,qBAAqB,EAAED,UAAU,CAAC,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,wBAAwB,GACxB,MAAME,aAAa,GAAG;IAAC,cAAc;IAAE,SAAS;IAAE,SAAS;IAAE,OAAO;IAAE,MAAM;IAAE,OAAO;IAAE,QAAQ;IAAE,OAAO;CAAC,AAAS,AAAC;AACnH,MAAMC,gBAAgB,GAAG,IAAIC,GAAG,CAASF,aAAa,CAAC,AAAC;AAMxD,SAASV,UAAU,CAACL,WAAwB,EAAkC;IAC5E,OAAOgB,gBAAgB,CAACE,GAAG,CAAClB,WAAW,CAACmB,IAAI,CAAC,CAAC;AAChD,CAAC;AAED,SAASb,UAAU,CAACP,KAAa,EAAEC,WAA4B,EAAU;IACvE,iEAAiE;IACjE,MAAMoB,QAAQ,GAAa,EAAE,AAAC;IAC9B,OAAQpB,WAAW,CAACmB,IAAI;QACtB,KAAK,cAAc;YACjBC,QAAQ,CAACC,OAAO,GAAGtB,KAAK,GAAG,IAAI,CAAC;YAChC,MAAM;QACR,KAAK,SAAS;YACZqB,QAAQ,CAACC,OAAO,GAAGtB,KAAK,CAAC;YACzB,MAAM;QACR,KAAK,SAAS;YACZqB,QAAQ,CAACE,OAAO,GAAGvB,KAAK,CAAC;YACzB,MAAM;QACR,KAAK,OAAO;YACVqB,QAAQ,CAACG,KAAK,GAAGxB,KAAK,CAAC;YACvB,MAAM;QACR,KAAK,MAAM;YACTqB,QAAQ,CAACI,IAAI,GAAGzB,KAAK,CAAC;YACtB,MAAM;QACR,KAAK,OAAO;YACVqB,QAAQ,CAACK,KAAK,GAAG1B,KAAK,CAAC;YACvB,MAAM;QACR,KAAK,QAAQ;YACXqB,QAAQ,CAACM,MAAM,GAAG3B,KAAK,CAAC;YACxB,MAAM;QACR,KAAK,OAAO;YACVqB,QAAQ,CAACO,KAAK,GAAG5B,KAAK,CAAC;YACvB,MAAM;QACR;YAAS;gBACP,MAAMc,UAAU,GAAUb,WAAW,CAACmB,IAAI,AAAC;gBAC3C,MAAM,IAAIL,KAAK,CAAC,CAAC,uBAAuB,EAAED,UAAU,CAAC,CAAC,CAAC,CAAC;YAC1D,CAAC;KACF;IAED,0EAA0E;IAC1E,MAAMe,EAAE,GAAGjC,YAAY,CAACyB,QAAQ,CAAC,AAAC;IAClC,MAAMC,OAAO,GAAGO,EAAE,GAAG,IAAI,AAAC;IAC1B,IAAIP,OAAO,GAAG,CAAC,EAAE;QACf,OAAO,CAAC,EAAEO,EAAE,CAACC,OAAO,EAAE,CAAC,aAAa,CAAC,CAAC;IACxC,CAAC;IAED,MAAMP,OAAO,GAAGD,OAAO,GAAG,EAAE,AAAC;IAC7B,IAAIC,OAAO,GAAG,CAAC,EAAE;QACf,OAAO,CAAC,EAAED,OAAO,CAACQ,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,MAAMN,KAAK,GAAGD,OAAO,GAAG,EAAE,AAAC;IAC3B,IAAIC,KAAK,GAAG,CAAC,EAAE;QACb,OAAO,CAAC,EAAED,OAAO,CAACO,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,MAAML,IAAI,GAAGD,KAAK,GAAG,EAAE,AAAC;IACxB,IAAIC,IAAI,GAAG,CAAC,EAAE;QACZ,OAAO,CAAC,EAAED,KAAK,CAACM,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAED,MAAMJ,KAAK,GAAGD,IAAI,GAAG,CAAC,AAAC;IACvB,IAAIC,KAAK,GAAG,CAAC,EAAE;QACb,OAAO,CAAC,EAAED,IAAI,CAACK,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,MAAMF,KAAK,GAAGF,KAAK,GAAG,EAAE,AAAC;IACzB,IAAIE,KAAK,GAAG,CAAC,EAAE;QACb,OAAO,CAAC,EAAEF,KAAK,CAACI,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAED,OAAO,CAAC,EAAEF,KAAK,CAACE,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC;AAED,2BAA2B,GAC3B,MAAMC,gBAAgB,GAAG;IAAC,SAAS;IAAE,gBAAgB;IAAE,GAAG;CAAC,AAAS,AAAC;AACrE,MAAMC,mBAAmB,GAAG,IAAId,GAAG,CAASa,gBAAgB,CAAC,AAAC;AAO9D,SAASvB,aAAa,CAACP,WAAwB,EAAqC;IAClF,OAAO+B,mBAAmB,CAACb,GAAG,CAAClB,WAAW,CAACmB,IAAI,CAAC,CAAC;AACnD,CAAC;AAED,SAASX,aAAa,CAACT,KAAa,EAAEC,WAA+B,EAAU;QAC5DA,eAA0B;IAA3C,MAAMU,QAAQ,GAAGV,CAAAA,eAA0B,GAA1BA,WAAW,CAACW,cAAc,cAA1BX,eAA0B,cAA1BA,eAA0B,GAAIH,sBAAsB,AAAC;IAEtE,IAAIG,WAAW,CAACmB,IAAI,KAAK,gBAAgB,EAAE;QACzCpB,KAAK,GAAGA,KAAK,GAAG,GAAG,CAAC;IACtB,CAAC;IAED,OAAOA,KAAK,CAAC8B,OAAO,CAACnB,QAAQ,CAAC,GAAG,GAAG,CAAC;AACvC,CAAC;AAED,2BAA2B,GAC3B,MAAMsB,gBAAgB,GAAG;IAAC,SAAS;CAAC,AAAS,AAAC;AAC9C,MAAMC,mBAAmB,GAAG,IAAIhB,GAAG,CAASe,gBAAgB,CAAC,AAAC;AAQ9D,SAAS7B,aAAa,CAACH,WAAwB,EAAqC;IAClF,OAAOiC,mBAAmB,CAACf,GAAG,CAAClB,WAAW,CAACmB,IAAI,CAAC,CAAC;AACnD,CAAC;AAED,SAASf,aAAa,CAACL,KAAa,EAAEC,WAA+B,EAAU;QAC5DA,eAA0B;IAA3C,MAAMU,QAAQ,GAAGV,CAAAA,eAA0B,GAA1BA,WAAW,CAACW,cAAc,cAA1BX,eAA0B,cAA1BA,eAA0B,GAAIH,sBAAsB,AAAC;IAEtE,IAAIG,WAAW,CAACkC,UAAU,KAAK,IAAI,EAAE;QACnC,OAAOC,qBAAqB,CAACpC,KAAK,EAAEW,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,MAAM0B,YAAY,GAA6B;QAC7CC,KAAK,EAAE,SAAS;QAChBC,qBAAqB,EAAE,CAAC;QACxBC,qBAAqB,EAAE7B,QAAQ;QAC/B8B,WAAW,EAAE,IAAI;KAClB,AAAC;IACF,MAAMC,gBAAgB,GAAG,IAAIC,IAAI,CAACC,YAAY,CAAC,OAAO,EAAEP,YAAY,CAAC,AAAC;IACtE,OAAOK,gBAAgB,CAACG,MAAM,CAAC7C,KAAK,CAAC,CAAC;AACxC,CAAC;AAED;;;;CAIC,GACD,OAAO,SAASoC,qBAAqB,CAACU,GAAW,EAAEnC,QAAQ,GAAG,CAAC,EAAE;IAC/D,MAAMoC,QAAQ,GAAG,CAACC,CAAS,GAAKnD,KAAK,CAACmD,CAAC,EAAErC,QAAQ,CAAC,AAAC;IACnD,OAAOsC,YAAY,CAACH,GAAG,EAAEC,QAAQ,CAAC,CAAC;AACrC,CAAC;AAED;;;CAGC,GACD,OAAO,SAASE,YAAY,CAACH,GAAW,EAAEC,QAAgC,EAAU;IAClF,MAAMG,EAAE,GAAGH,QAAQ,aAARA,QAAQ,cAARA,QAAQ,GAAII,IAAI,CAACtD,KAAK,AAAC;IAElC,OAAOiD,GAAG,IAAI,IAAI,GACdI,EAAE,CAACJ,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,GACpBA,GAAG,IAAI,GAAG,GACVI,EAAE,CAACJ,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,GACnBA,GAAG,IAAI,GAAG,GACVI,EAAE,CAACJ,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,GACnBA,GAAG,IAAI,GAAG,GACVI,EAAE,CAACJ,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,GACnBA,GAAG,CAAC3C,QAAQ,EAAE,CAAC;AACrB,CAAC;AAED,yBAAyB,GACzB,MAAMiD,cAAc,GAAG;IAAC,OAAO;CAAC,AAAS,AAAC;AAC1C,MAAMC,iBAAiB,GAAG,IAAInC,GAAG,CAASkC,cAAc,CAAC,AAAC;AAO1D,SAAS1C,WAAW,CAACT,WAAwB,EAAmC;IAC9E,OAAOoD,iBAAiB,CAAClC,GAAG,CAAClB,WAAW,CAACmB,IAAI,CAAC,CAAC;AACjD,CAAC;AAED,gIAAgI;AAChI,SAASP,WAAW,CAACyC,KAAa,EAAE3C,QAAQ,GAAG,CAAC,EAAE;IAChD,IAAI2C,KAAK,KAAK,CAAC,EAAE,OAAO,SAAS,CAAC;IAElC,MAAMC,CAAC,GAAG,IAAI,AAAC;IACf,MAAMC,EAAE,GAAG7C,QAAQ,GAAG,CAAC,GAAG,CAAC,GAAGA,QAAQ,AAAC;IACvC,MAAM8C,KAAK,GAAG;QAAC,OAAO;QAAE,IAAI;QAAE,IAAI;QAAE,IAAI;QAAE,IAAI;QAAE,IAAI;QAAE,IAAI;QAAE,IAAI;QAAE,IAAI;KAAC,AAAC;IAExE,6EAA6E;IAC7E,6GAA6G;IAC7G,MAAMC,CAAC,GAAGP,IAAI,CAACQ,GAAG,CAAC,CAAC,EAAER,IAAI,CAACS,KAAK,CAACT,IAAI,CAACU,GAAG,CAACP,KAAK,CAAC,GAAGH,IAAI,CAACU,GAAG,CAACN,CAAC,CAAC,CAAC,CAAC,AAAC;IAEjE,OAAOO,UAAU,CAAC,AAACR,CAAAA,KAAK,GAAGH,IAAI,CAACY,GAAG,CAACR,CAAC,EAAEG,CAAC,CAAC,CAAA,CAAE5B,OAAO,CAAC0B,EAAE,CAAC,CAAC,GAAG,GAAG,GAAGC,KAAK,CAACC,CAAC,CAAC,CAAC;AAC3E,CAAC"}