@perses-dev/core 0.37.2 → 0.39.0

package/dist/model/units/bytes.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/model/units/bytes.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 numbro from 'numbro';\n\nimport { MAX_SIGNIFICANT_DIGITS } from './constants';\nimport { UnitGroupConfig, UnitConfig } from './types';\nimport { hasDecimalPlaces, limitDecimalPlaces, shouldAbbreviate } from './utils';\n\nconst DEFAULT_NUMBRO_MANTISSA = 2;\n\nconst bytesUnitKinds = ['Bytes'] as const;\ntype BytesUnitKind = (typeof bytesUnitKinds)[number];\nexport type BytesUnitOptions = {\n  kind: BytesUnitKind;\n  decimal_places?: number;\n  abbreviate?: boolean;\n};\nexport const BYTES_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Bytes',\n  decimal_places: true,\n  abbreviate: true,\n};\nexport const BYTES_UNIT_CONFIG: Readonly<Record<BytesUnitKind, UnitConfig>> = {\n  // These units are powers of 1000.\n  // In other words, 1 KB = 1000 bytes.\n  Bytes: {\n    group: 'Bytes',\n    label: 'Bytes',\n  },\n};\n\nexport function formatBytes(bytes: number, options: BytesUnitOptions) {\n  const { abbreviate, decimal_places } = options;\n\n  if (!shouldAbbreviate(abbreviate) || Math.abs(bytes) < 1000) {\n    const formatterOptions: Intl.NumberFormatOptions = {\n      style: 'unit',\n      unit: 'byte',\n      unitDisplay: 'long',\n      useGrouping: true,\n    };\n\n    if (hasDecimalPlaces(decimal_places)) {\n      formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);\n      formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimal_places);\n    } else {\n      // This can happen if bytes is between -1000 and 1000\n      if (shouldAbbreviate(abbreviate)) {\n        formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;\n      }\n    }\n\n    return Intl.NumberFormat('en-US', formatterOptions).format(bytes);\n  }\n\n  // numbro is able to add units like KB, MB, GB, etc. correctly\n  return numbro(bytes).format({\n    output: 'byte',\n    base: 'decimal',\n    spaceSeparated: true,\n    mantissa: hasDecimalPlaces(decimal_places) ? decimal_places : DEFAULT_NUMBRO_MANTISSA,\n    // trimMantissa trims trailing 0s\n    trimMantissa: !hasDecimalPlaces(decimal_places),\n    // optionalMantissa excludes all the decimal places if they're all zeros\n    optionalMantissa: !hasDecimalPlaces(decimal_places),\n  });\n}\n"],"names":["numbro","MAX_SIGNIFICANT_DIGITS","hasDecimalPlaces","limitDecimalPlaces","shouldAbbreviate","DEFAULT_NUMBRO_MANTISSA","bytesUnitKinds","BYTES_GROUP_CONFIG","label","decimal_places","abbreviate","BYTES_UNIT_CONFIG","Bytes","group","formatBytes","bytes","options","Math","abs","formatterOptions","style","unit","unitDisplay","useGrouping","minimumFractionDigits","maximumFractionDigits","maximumSignificantDigits","Intl","NumberFormat","format","output","base","spaceSeparated","mantissa","trimMantissa","optionalMantissa"],"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,MAAM,MAAM,QAAQ,CAAC;AAE5B,SAASC,sBAAsB,QAAQ,aAAa,CAAC;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,EAAEC,gBAAgB,QAAQ,SAAS,CAAC;AAEjF,MAAMC,uBAAuB,GAAG,CAAC,AAAC;AAElC,MAAMC,cAAc,GAAG;IAAC,OAAO;CAAC,AAAS,AAAC;AAO1C,OAAO,MAAMC,kBAAkB,GAAoB;IACjDC,KAAK,EAAE,OAAO;IACdC,cAAc,EAAE,IAAI;IACpBC,UAAU,EAAE,IAAI;CACjB,CAAC;AACF,OAAO,MAAMC,iBAAiB,GAAgD;IAC5E,kCAAkC;IAClC,qCAAqC;IACrCC,KAAK,EAAE;QACLC,KAAK,EAAE,OAAO;QACdL,KAAK,EAAE,OAAO;KACf;CACF,CAAC;AAEF,OAAO,SAASM,WAAW,CAACC,KAAa,EAAEC,OAAyB,EAAE;IACpE,MAAM,EAAEN,UAAU,CAAA,EAAED,cAAc,CAAA,EAAE,GAAGO,OAAO,AAAC;IAE/C,IAAI,CAACZ,gBAAgB,CAACM,UAAU,CAAC,IAAIO,IAAI,CAACC,GAAG,CAACH,KAAK,CAAC,GAAG,IAAI,EAAE;QAC3D,MAAMI,gBAAgB,GAA6B;YACjDC,KAAK,EAAE,MAAM;YACbC,IAAI,EAAE,MAAM;YACZC,WAAW,EAAE,MAAM;YACnBC,WAAW,EAAE,IAAI;SAClB,AAAC;QAEF,IAAIrB,gBAAgB,CAACO,cAAc,CAAC,EAAE;YACpCU,gBAAgB,CAACK,qBAAqB,GAAGrB,kBAAkB,CAACM,cAAc,CAAC,CAAC;YAC5EU,gBAAgB,CAACM,qBAAqB,GAAGtB,kBAAkB,CAACM,cAAc,CAAC,CAAC;QAC9E,OAAO;YACL,qDAAqD;YACrD,IAAIL,gBAAgB,CAACM,UAAU,CAAC,EAAE;gBAChCS,gBAAgB,CAACO,wBAAwB,GAAGzB,sBAAsB,CAAC;YACrE,CAAC;QACH,CAAC;QAED,OAAO0B,IAAI,CAACC,YAAY,CAAC,OAAO,EAAET,gBAAgB,CAAC,CAACU,MAAM,CAACd,KAAK,CAAC,CAAC;IACpE,CAAC;IAED,8DAA8D;IAC9D,OAAOf,MAAM,CAACe,KAAK,CAAC,CAACc,MAAM,CAAC;QAC1BC,MAAM,EAAE,MAAM;QACdC,IAAI,EAAE,SAAS;QACfC,cAAc,EAAE,IAAI;QACpBC,QAAQ,EAAE/B,gBAAgB,CAACO,cAAc,CAAC,GAAGA,cAAc,GAAGJ,uBAAuB;QACrF,iCAAiC;QACjC6B,YAAY,EAAE,CAAChC,gBAAgB,CAACO,cAAc,CAAC;QAC/C,wEAAwE;QACxE0B,gBAAgB,EAAE,CAACjC,gBAAgB,CAACO,cAAc,CAAC;KACpD,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"sources":["../../../src/model/units/bytes.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 numbro from 'numbro';\n\nimport { MAX_SIGNIFICANT_DIGITS } from './constants';\nimport { UnitGroupConfig, UnitConfig } from './types';\nimport { hasDecimalPlaces, limitDecimalPlaces, shouldAbbreviate } from './utils';\n\n/**\n * We consider the units for bytes to be powers of 1000.\n * In other words:\n * 1 KB = 1000 bytes (1000^1 bytes)\n * 1 MB = 1,000,000 bytes (1000^2 bytes)\n * etc.\n */\n\nconst DEFAULT_NUMBRO_MANTISSA = 2;\n\nconst bytesUnitKinds = ['Bytes'] as const;\ntype BytesUnitKind = (typeof bytesUnitKinds)[number];\nexport type BytesUnitOptions = {\n  kind: BytesUnitKind;\n  decimal_places?: number;\n  abbreviate?: boolean;\n};\nexport const BYTES_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Bytes',\n  decimal_places: true,\n  abbreviate: true,\n};\nexport const BYTES_UNIT_CONFIG: Readonly<Record<BytesUnitKind, UnitConfig>> = {\n  Bytes: {\n    group: 'Bytes',\n    label: 'Bytes',\n  },\n};\n\nexport function formatBytes(bytes: number, { abbreviate, decimal_places }: BytesUnitOptions) {\n  // If we're showing the entire value, we can use Intl.NumberFormat.\n  if (!shouldAbbreviate(abbreviate) || Math.abs(bytes) < 1000) {\n    const formatterOptions: Intl.NumberFormatOptions = {\n      style: 'unit',\n      unit: 'byte',\n      unitDisplay: 'long',\n      useGrouping: true,\n    };\n\n    if (hasDecimalPlaces(decimal_places)) {\n      formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);\n      formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimal_places);\n    } else {\n      // This can happen if bytes is between -1000 and 1000\n      if (shouldAbbreviate(abbreviate)) {\n        formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;\n      }\n    }\n    const formatter = Intl.NumberFormat('en-US', formatterOptions);\n    return formatter.format(bytes);\n  }\n\n  // If we're showing the \"abbreviated\" value, we use numbro.\n  // numbro is able to add units like KB, MB, GB, etc. correctly.\n  return numbro(bytes).format({\n    output: 'byte',\n    base: 'decimal',\n    spaceSeparated: true,\n    mantissa: hasDecimalPlaces(decimal_places) ? decimal_places : DEFAULT_NUMBRO_MANTISSA,\n    // trimMantissa trims trailing 0s\n    trimMantissa: !hasDecimalPlaces(decimal_places),\n    // optionalMantissa excludes all the decimal places if they're all zeros\n    optionalMantissa: !hasDecimalPlaces(decimal_places),\n  });\n}\n"],"names":["numbro","MAX_SIGNIFICANT_DIGITS","hasDecimalPlaces","limitDecimalPlaces","shouldAbbreviate","DEFAULT_NUMBRO_MANTISSA","bytesUnitKinds","BYTES_GROUP_CONFIG","label","decimal_places","abbreviate","BYTES_UNIT_CONFIG","Bytes","group","formatBytes","bytes","Math","abs","formatterOptions","style","unit","unitDisplay","useGrouping","minimumFractionDigits","maximumFractionDigits","maximumSignificantDigits","formatter","Intl","NumberFormat","format","output","base","spaceSeparated","mantissa","trimMantissa","optionalMantissa"],"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,MAAM,MAAM,QAAQ,CAAC;AAE5B,SAASC,sBAAsB,QAAQ,aAAa,CAAC;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,EAAEC,gBAAgB,QAAQ,SAAS,CAAC;AAEjF;;;;;;CAMC,GAED,MAAMC,uBAAuB,GAAG,CAAC,AAAC;AAElC,MAAMC,cAAc,GAAG;IAAC,OAAO;CAAC,AAAS,AAAC;AAO1C,OAAO,MAAMC,kBAAkB,GAAoB;IACjDC,KAAK,EAAE,OAAO;IACdC,cAAc,EAAE,IAAI;IACpBC,UAAU,EAAE,IAAI;CACjB,CAAC;AACF,OAAO,MAAMC,iBAAiB,GAAgD;IAC5EC,KAAK,EAAE;QACLC,KAAK,EAAE,OAAO;QACdL,KAAK,EAAE,OAAO;KACf;CACF,CAAC;AAEF,OAAO,SAASM,WAAW,CAACC,KAAa,EAAE,EAAEL,UAAU,CAAA,EAAED,cAAc,CAAA,EAAoB,EAAE;IAC3F,mEAAmE;IACnE,IAAI,CAACL,gBAAgB,CAACM,UAAU,CAAC,IAAIM,IAAI,CAACC,GAAG,CAACF,KAAK,CAAC,GAAG,IAAI,EAAE;QAC3D,MAAMG,gBAAgB,GAA6B;YACjDC,KAAK,EAAE,MAAM;YACbC,IAAI,EAAE,MAAM;YACZC,WAAW,EAAE,MAAM;YACnBC,WAAW,EAAE,IAAI;SAClB,AAAC;QAEF,IAAIpB,gBAAgB,CAACO,cAAc,CAAC,EAAE;YACpCS,gBAAgB,CAACK,qBAAqB,GAAGpB,kBAAkB,CAACM,cAAc,CAAC,CAAC;YAC5ES,gBAAgB,CAACM,qBAAqB,GAAGrB,kBAAkB,CAACM,cAAc,CAAC,CAAC;QAC9E,OAAO;YACL,qDAAqD;YACrD,IAAIL,gBAAgB,CAACM,UAAU,CAAC,EAAE;gBAChCQ,gBAAgB,CAACO,wBAAwB,GAAGxB,sBAAsB,CAAC;YACrE,CAAC;QACH,CAAC;QACD,MAAMyB,SAAS,GAAGC,IAAI,CAACC,YAAY,CAAC,OAAO,EAAEV,gBAAgB,CAAC,AAAC;QAC/D,OAAOQ,SAAS,CAACG,MAAM,CAACd,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,2DAA2D;IAC3D,+DAA+D;IAC/D,OAAOf,MAAM,CAACe,KAAK,CAAC,CAACc,MAAM,CAAC;QAC1BC,MAAM,EAAE,MAAM;QACdC,IAAI,EAAE,SAAS;QACfC,cAAc,EAAE,IAAI;QACpBC,QAAQ,EAAE/B,gBAAgB,CAACO,cAAc,CAAC,GAAGA,cAAc,GAAGJ,uBAAuB;QACrF,iCAAiC;QACjC6B,YAAY,EAAE,CAAChC,gBAAgB,CAACO,cAAc,CAAC;QAC/C,wEAAwE;QACxE0B,gBAAgB,EAAE,CAACjC,gBAAgB,CAACO,cAAc,CAAC;KACpD,CAAC,CAAC;AACL,CAAC"}

package/dist/model/units/decimal.d.ts

@@ -8,6 +8,6 @@ export declare type DecimalUnitOptions = {
 };
 export declare const DECIMAL_GROUP_CONFIG: UnitGroupConfig;
 export declare const DECIMAL_UNIT_CONFIG: Readonly<Record<DecimalUnitKind, UnitConfig>>;
-export declare function formatDecimal(value: number, options: DecimalUnitOptions): string;
+export declare function formatDecimal(value: number, { abbreviate, decimal_places }: DecimalUnitOptions): string;
 export {};
 //# sourceMappingURL=decimal.d.ts.map

package/dist/model/units/decimal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decimal.d.ts","sourceRoot":"","sources":["../../../src/model/units/decimal.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAGtD,QAAA,MAAM,gBAAgB,sBAAuB,CAAC;AAC9C,aAAK,eAAe,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AACzD,oBAAY,kBAAkB,GAAG;IAC/B,IAAI,EAAE,eAAe,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AACF,eAAO,MAAM,oBAAoB,EAAE,eAIlC,CAAC;AACF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC,CAK7E,CAAC;AAEF,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAsBhF"}
+{"version":3,"file":"decimal.d.ts","sourceRoot":"","sources":["../../../src/model/units/decimal.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAGtD,QAAA,MAAM,gBAAgB,sBAAuB,CAAC;AAC9C,aAAK,eAAe,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AACzD,oBAAY,kBAAkB,GAAG;IAC/B,IAAI,EAAE,eAAe,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AACF,eAAO,MAAM,oBAAoB,EAAE,eAIlC,CAAC;AACF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC,CAK7E,CAAC;AAEF,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,cAAc,EAAE,EAAE,kBAAkB,GAAG,MAAM,CAqBvG"}

package/dist/model/units/decimal.js

@@ -26,8 +26,7 @@ export const DECIMAL_UNIT_CONFIG = {
         label: 'Decimal'
     }
 };
-export function formatDecimal(value, options) {
-    const { abbreviate , decimal_places  } = options;
+export function formatDecimal(value, { abbreviate , decimal_places  }) {
     const formatterOptions = {
         style: 'decimal',
         useGrouping: true
@@ -43,7 +42,8 @@ export function formatDecimal(value, options) {
             formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;
         }
     }
-    return Intl.NumberFormat('en-US', formatterOptions).format(value);
+    const formatter = Intl.NumberFormat('en-US', formatterOptions);
+    return formatter.format(value);
 }
 
 //# sourceMappingURL=decimal.js.map

package/dist/model/units/decimal.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/model/units/decimal.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 { MAX_SIGNIFICANT_DIGITS } from './constants';\nimport { UnitGroupConfig, UnitConfig } from './types';\nimport { hasDecimalPlaces, limitDecimalPlaces, shouldAbbreviate } from './utils';\n\nconst decimalUnitKinds = ['Decimal'] as const;\ntype DecimalUnitKind = (typeof decimalUnitKinds)[number];\nexport type DecimalUnitOptions = {\n  kind: DecimalUnitKind;\n  decimal_places?: number;\n  abbreviate?: boolean;\n};\nexport const DECIMAL_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Decimal',\n  decimal_places: true,\n  abbreviate: true,\n};\nexport const DECIMAL_UNIT_CONFIG: Readonly<Record<DecimalUnitKind, UnitConfig>> = {\n  Decimal: {\n    group: 'Decimal',\n    label: 'Decimal',\n  },\n};\n\nexport function formatDecimal(value: number, options: DecimalUnitOptions): string {\n  const { abbreviate, decimal_places } = options;\n\n  const formatterOptions: Intl.NumberFormatOptions = {\n    style: 'decimal',\n    useGrouping: true,\n  };\n\n  if (shouldAbbreviate(abbreviate)) {\n    formatterOptions.notation = 'compact';\n  }\n\n  if (hasDecimalPlaces(decimal_places)) {\n    formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);\n    formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimal_places);\n  } else {\n    if (shouldAbbreviate(abbreviate)) {\n      formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;\n    }\n  }\n\n  return Intl.NumberFormat('en-US', formatterOptions).format(value);\n}\n"],"names":["MAX_SIGNIFICANT_DIGITS","hasDecimalPlaces","limitDecimalPlaces","shouldAbbreviate","decimalUnitKinds","DECIMAL_GROUP_CONFIG","label","decimal_places","abbreviate","DECIMAL_UNIT_CONFIG","Decimal","group","formatDecimal","value","options","formatterOptions","style","useGrouping","notation","minimumFractionDigits","maximumFractionDigits","maximumSignificantDigits","Intl","NumberFormat","format"],"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,sBAAsB,QAAQ,aAAa,CAAC;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,EAAEC,gBAAgB,QAAQ,SAAS,CAAC;AAEjF,MAAMC,gBAAgB,GAAG;IAAC,SAAS;CAAC,AAAS,AAAC;AAO9C,OAAO,MAAMC,oBAAoB,GAAoB;IACnDC,KAAK,EAAE,SAAS;IAChBC,cAAc,EAAE,IAAI;IACpBC,UAAU,EAAE,IAAI;CACjB,CAAC;AACF,OAAO,MAAMC,mBAAmB,GAAkD;IAChFC,OAAO,EAAE;QACPC,KAAK,EAAE,SAAS;QAChBL,KAAK,EAAE,SAAS;KACjB;CACF,CAAC;AAEF,OAAO,SAASM,aAAa,CAACC,KAAa,EAAEC,OAA2B,EAAU;IAChF,MAAM,EAAEN,UAAU,CAAA,EAAED,cAAc,CAAA,EAAE,GAAGO,OAAO,AAAC;IAE/C,MAAMC,gBAAgB,GAA6B;QACjDC,KAAK,EAAE,SAAS;QAChBC,WAAW,EAAE,IAAI;KAClB,AAAC;IAEF,IAAId,gBAAgB,CAACK,UAAU,CAAC,EAAE;QAChCO,gBAAgB,CAACG,QAAQ,GAAG,SAAS,CAAC;IACxC,CAAC;IAED,IAAIjB,gBAAgB,CAACM,cAAc,CAAC,EAAE;QACpCQ,gBAAgB,CAACI,qBAAqB,GAAGjB,kBAAkB,CAACK,cAAc,CAAC,CAAC;QAC5EQ,gBAAgB,CAACK,qBAAqB,GAAGlB,kBAAkB,CAACK,cAAc,CAAC,CAAC;IAC9E,OAAO;QACL,IAAIJ,gBAAgB,CAACK,UAAU,CAAC,EAAE;YAChCO,gBAAgB,CAACM,wBAAwB,GAAGrB,sBAAsB,CAAC;QACrE,CAAC;IACH,CAAC;IAED,OAAOsB,IAAI,CAACC,YAAY,CAAC,OAAO,EAAER,gBAAgB,CAAC,CAACS,MAAM,CAACX,KAAK,CAAC,CAAC;AACpE,CAAC"}
+{"version":3,"sources":["../../../src/model/units/decimal.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 { MAX_SIGNIFICANT_DIGITS } from './constants';\nimport { UnitGroupConfig, UnitConfig } from './types';\nimport { hasDecimalPlaces, limitDecimalPlaces, shouldAbbreviate } from './utils';\n\nconst decimalUnitKinds = ['Decimal'] as const;\ntype DecimalUnitKind = (typeof decimalUnitKinds)[number];\nexport type DecimalUnitOptions = {\n  kind: DecimalUnitKind;\n  decimal_places?: number;\n  abbreviate?: boolean;\n};\nexport const DECIMAL_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Decimal',\n  decimal_places: true,\n  abbreviate: true,\n};\nexport const DECIMAL_UNIT_CONFIG: Readonly<Record<DecimalUnitKind, UnitConfig>> = {\n  Decimal: {\n    group: 'Decimal',\n    label: 'Decimal',\n  },\n};\n\nexport function formatDecimal(value: number, { abbreviate, decimal_places }: DecimalUnitOptions): string {\n  const formatterOptions: Intl.NumberFormatOptions = {\n    style: 'decimal',\n    useGrouping: true,\n  };\n\n  if (shouldAbbreviate(abbreviate)) {\n    formatterOptions.notation = 'compact';\n  }\n\n  if (hasDecimalPlaces(decimal_places)) {\n    formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);\n    formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimal_places);\n  } else {\n    if (shouldAbbreviate(abbreviate)) {\n      formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;\n    }\n  }\n\n  const formatter = Intl.NumberFormat('en-US', formatterOptions);\n  return formatter.format(value);\n}\n"],"names":["MAX_SIGNIFICANT_DIGITS","hasDecimalPlaces","limitDecimalPlaces","shouldAbbreviate","decimalUnitKinds","DECIMAL_GROUP_CONFIG","label","decimal_places","abbreviate","DECIMAL_UNIT_CONFIG","Decimal","group","formatDecimal","value","formatterOptions","style","useGrouping","notation","minimumFractionDigits","maximumFractionDigits","maximumSignificantDigits","formatter","Intl","NumberFormat","format"],"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,sBAAsB,QAAQ,aAAa,CAAC;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,EAAEC,gBAAgB,QAAQ,SAAS,CAAC;AAEjF,MAAMC,gBAAgB,GAAG;IAAC,SAAS;CAAC,AAAS,AAAC;AAO9C,OAAO,MAAMC,oBAAoB,GAAoB;IACnDC,KAAK,EAAE,SAAS;IAChBC,cAAc,EAAE,IAAI;IACpBC,UAAU,EAAE,IAAI;CACjB,CAAC;AACF,OAAO,MAAMC,mBAAmB,GAAkD;IAChFC,OAAO,EAAE;QACPC,KAAK,EAAE,SAAS;QAChBL,KAAK,EAAE,SAAS;KACjB;CACF,CAAC;AAEF,OAAO,SAASM,aAAa,CAACC,KAAa,EAAE,EAAEL,UAAU,CAAA,EAAED,cAAc,CAAA,EAAsB,EAAU;IACvG,MAAMO,gBAAgB,GAA6B;QACjDC,KAAK,EAAE,SAAS;QAChBC,WAAW,EAAE,IAAI;KAClB,AAAC;IAEF,IAAIb,gBAAgB,CAACK,UAAU,CAAC,EAAE;QAChCM,gBAAgB,CAACG,QAAQ,GAAG,SAAS,CAAC;IACxC,CAAC;IAED,IAAIhB,gBAAgB,CAACM,cAAc,CAAC,EAAE;QACpCO,gBAAgB,CAACI,qBAAqB,GAAGhB,kBAAkB,CAACK,cAAc,CAAC,CAAC;QAC5EO,gBAAgB,CAACK,qBAAqB,GAAGjB,kBAAkB,CAACK,cAAc,CAAC,CAAC;IAC9E,OAAO;QACL,IAAIJ,gBAAgB,CAACK,UAAU,CAAC,EAAE;YAChCM,gBAAgB,CAACM,wBAAwB,GAAGpB,sBAAsB,CAAC;QACrE,CAAC;IACH,CAAC;IAED,MAAMqB,SAAS,GAAGC,IAAI,CAACC,YAAY,CAAC,OAAO,EAAET,gBAAgB,CAAC,AAAC;IAC/D,OAAOO,SAAS,CAACG,MAAM,CAACX,KAAK,CAAC,CAAC;AACjC,CAAC"}

package/dist/model/units/percent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"percent.d.ts","sourceRoot":"","sources":["../../../src/model/units/percent.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAGtD,QAAA,MAAM,gBAAgB,6CAA8C,CAAC;AACrE,aAAK,eAAe,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AACzD,oBAAY,kBAAkB,GAAG;IAC/B,IAAI,EAAE,eAAe,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,eAAO,MAAM,oBAAoB,EAAE,eAGlC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC,CAgB7E,CAAC;AAEF,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,kBAAkB,GAAG,MAAM,CAmBjG"}
+{"version":3,"file":"percent.d.ts","sourceRoot":"","sources":["../../../src/model/units/percent.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAGtD,QAAA,MAAM,gBAAgB,6CAA8C,CAAC;AACrE,aAAK,eAAe,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AACzD,oBAAY,kBAAkB,GAAG;IAC/B,IAAI,EAAE,eAAe,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,eAAO,MAAM,oBAAoB,EAAE,eAGlC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC,CAgB7E,CAAC;AAEF,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,kBAAkB,GAAG,MAAM,CAoBjG"}

package/dist/model/units/percent.js

@@ -40,10 +40,6 @@ export const PERCENT_UNIT_CONFIG = {
     }
 };
 export function formatPercent(value, { kind , decimal_places  }) {
-    // Intl.NumberFormat translates 0 -> 0%, 0.5 -> 50%, 1 -> 100%
-    if (kind === 'Percent') {
-        value = value / 100;
-    }
     const formatterOptions = {
         style: 'percent',
         useGrouping: true
@@ -54,7 +50,12 @@ export function formatPercent(value, { kind , decimal_places  }) {
     } else {
         formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;
     }
-    return Intl.NumberFormat('en-US', formatterOptions).format(value);
+    // Intl.NumberFormat translates 0 -> 0%, 0.5 -> 50%, 1 -> 100%, etc.
+    if (kind === 'Percent') {
+        value = value / 100;
+    }
+    const formatter = Intl.NumberFormat('en-US', formatterOptions);
+    return formatter.format(value);
 }
 
 //# sourceMappingURL=percent.js.map

package/dist/model/units/percent.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/model/units/percent.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 { MAX_SIGNIFICANT_DIGITS } from './constants';\nimport { UnitGroupConfig, UnitConfig } from './types';\nimport { hasDecimalPlaces, limitDecimalPlaces } from './utils';\n\nconst percentUnitKinds = ['Percent', 'PercentDecimal', '%'] as const;\ntype PercentUnitKind = (typeof percentUnitKinds)[number];\nexport type PercentUnitOptions = {\n  kind: PercentUnitKind;\n  decimal_places?: number;\n};\nexport const PERCENT_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Percent',\n  decimal_places: true,\n};\nconst PERCENT_GROUP = 'Percent';\nexport const PERCENT_UNIT_CONFIG: Readonly<Record<PercentUnitKind, UnitConfig>> = {\n  Percent: {\n    group: PERCENT_GROUP,\n    label: 'Percent (0-100)',\n  },\n  PercentDecimal: {\n    group: PERCENT_GROUP,\n    label: 'Percent (0.0-1.0)',\n  },\n  '%': {\n    // This option is not shown in the selector because it is a shorthand\n    // duplicate of `Percent`.\n    disableSelectorOption: true,\n    group: PERCENT_GROUP,\n    label: '%',\n  },\n};\n\nexport function formatPercent(value: number, { kind, decimal_places }: PercentUnitOptions): string {\n  // Intl.NumberFormat translates 0 -> 0%, 0.5 -> 50%, 1 -> 100%\n  if (kind === 'Percent') {\n    value = value / 100;\n  }\n\n  const formatterOptions: Intl.NumberFormatOptions = {\n    style: 'percent',\n    useGrouping: true,\n  };\n\n  if (hasDecimalPlaces(decimal_places)) {\n    formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);\n    formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimal_places);\n  } else {\n    formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;\n  }\n\n  return Intl.NumberFormat('en-US', formatterOptions).format(value);\n}\n"],"names":["MAX_SIGNIFICANT_DIGITS","hasDecimalPlaces","limitDecimalPlaces","percentUnitKinds","PERCENT_GROUP_CONFIG","label","decimal_places","PERCENT_GROUP","PERCENT_UNIT_CONFIG","Percent","group","PercentDecimal","disableSelectorOption","formatPercent","value","kind","formatterOptions","style","useGrouping","minimumFractionDigits","maximumFractionDigits","maximumSignificantDigits","Intl","NumberFormat","format"],"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,sBAAsB,QAAQ,aAAa,CAAC;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,QAAQ,SAAS,CAAC;AAE/D,MAAMC,gBAAgB,GAAG;IAAC,SAAS;IAAE,gBAAgB;IAAE,GAAG;CAAC,AAAS,AAAC;AAMrE,OAAO,MAAMC,oBAAoB,GAAoB;IACnDC,KAAK,EAAE,SAAS;IAChBC,cAAc,EAAE,IAAI;CACrB,CAAC;AACF,MAAMC,aAAa,GAAG,SAAS,AAAC;AAChC,OAAO,MAAMC,mBAAmB,GAAkD;IAChFC,OAAO,EAAE;QACPC,KAAK,EAAEH,aAAa;QACpBF,KAAK,EAAE,iBAAiB;KACzB;IACDM,cAAc,EAAE;QACdD,KAAK,EAAEH,aAAa;QACpBF,KAAK,EAAE,mBAAmB;KAC3B;IACD,GAAG,EAAE;QACH,qEAAqE;QACrE,0BAA0B;QAC1BO,qBAAqB,EAAE,IAAI;QAC3BF,KAAK,EAAEH,aAAa;QACpBF,KAAK,EAAE,GAAG;KACX;CACF,CAAC;AAEF,OAAO,SAASQ,aAAa,CAACC,KAAa,EAAE,EAAEC,IAAI,CAAA,EAAET,cAAc,CAAA,EAAsB,EAAU;IACjG,8DAA8D;IAC9D,IAAIS,IAAI,KAAK,SAAS,EAAE;QACtBD,KAAK,GAAGA,KAAK,GAAG,GAAG,CAAC;IACtB,CAAC;IAED,MAAME,gBAAgB,GAA6B;QACjDC,KAAK,EAAE,SAAS;QAChBC,WAAW,EAAE,IAAI;KAClB,AAAC;IAEF,IAAIjB,gBAAgB,CAACK,cAAc,CAAC,EAAE;QACpCU,gBAAgB,CAACG,qBAAqB,GAAGjB,kBAAkB,CAACI,cAAc,CAAC,CAAC;QAC5EU,gBAAgB,CAACI,qBAAqB,GAAGlB,kBAAkB,CAACI,cAAc,CAAC,CAAC;IAC9E,OAAO;QACLU,gBAAgB,CAACK,wBAAwB,GAAGrB,sBAAsB,CAAC;IACrE,CAAC;IAED,OAAOsB,IAAI,CAACC,YAAY,CAAC,OAAO,EAAEP,gBAAgB,CAAC,CAACQ,MAAM,CAACV,KAAK,CAAC,CAAC;AACpE,CAAC"}
+{"version":3,"sources":["../../../src/model/units/percent.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 { MAX_SIGNIFICANT_DIGITS } from './constants';\nimport { UnitGroupConfig, UnitConfig } from './types';\nimport { hasDecimalPlaces, limitDecimalPlaces } from './utils';\n\nconst percentUnitKinds = ['Percent', 'PercentDecimal', '%'] as const;\ntype PercentUnitKind = (typeof percentUnitKinds)[number];\nexport type PercentUnitOptions = {\n  kind: PercentUnitKind;\n  decimal_places?: number;\n};\nexport const PERCENT_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Percent',\n  decimal_places: true,\n};\nconst PERCENT_GROUP = 'Percent';\nexport const PERCENT_UNIT_CONFIG: Readonly<Record<PercentUnitKind, UnitConfig>> = {\n  Percent: {\n    group: PERCENT_GROUP,\n    label: 'Percent (0-100)',\n  },\n  PercentDecimal: {\n    group: PERCENT_GROUP,\n    label: 'Percent (0.0-1.0)',\n  },\n  '%': {\n    // This option is not shown in the selector because it is a shorthand\n    // duplicate of `Percent`.\n    disableSelectorOption: true,\n    group: PERCENT_GROUP,\n    label: '%',\n  },\n};\n\nexport function formatPercent(value: number, { kind, decimal_places }: PercentUnitOptions): string {\n  const formatterOptions: Intl.NumberFormatOptions = {\n    style: 'percent',\n    useGrouping: true,\n  };\n\n  if (hasDecimalPlaces(decimal_places)) {\n    formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);\n    formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimal_places);\n  } else {\n    formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;\n  }\n\n  // Intl.NumberFormat translates 0 -> 0%, 0.5 -> 50%, 1 -> 100%, etc.\n  if (kind === 'Percent') {\n    value = value / 100;\n  }\n\n  const formatter = Intl.NumberFormat('en-US', formatterOptions);\n  return formatter.format(value);\n}\n"],"names":["MAX_SIGNIFICANT_DIGITS","hasDecimalPlaces","limitDecimalPlaces","percentUnitKinds","PERCENT_GROUP_CONFIG","label","decimal_places","PERCENT_GROUP","PERCENT_UNIT_CONFIG","Percent","group","PercentDecimal","disableSelectorOption","formatPercent","value","kind","formatterOptions","style","useGrouping","minimumFractionDigits","maximumFractionDigits","maximumSignificantDigits","formatter","Intl","NumberFormat","format"],"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,sBAAsB,QAAQ,aAAa,CAAC;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,QAAQ,SAAS,CAAC;AAE/D,MAAMC,gBAAgB,GAAG;IAAC,SAAS;IAAE,gBAAgB;IAAE,GAAG;CAAC,AAAS,AAAC;AAMrE,OAAO,MAAMC,oBAAoB,GAAoB;IACnDC,KAAK,EAAE,SAAS;IAChBC,cAAc,EAAE,IAAI;CACrB,CAAC;AACF,MAAMC,aAAa,GAAG,SAAS,AAAC;AAChC,OAAO,MAAMC,mBAAmB,GAAkD;IAChFC,OAAO,EAAE;QACPC,KAAK,EAAEH,aAAa;QACpBF,KAAK,EAAE,iBAAiB;KACzB;IACDM,cAAc,EAAE;QACdD,KAAK,EAAEH,aAAa;QACpBF,KAAK,EAAE,mBAAmB;KAC3B;IACD,GAAG,EAAE;QACH,qEAAqE;QACrE,0BAA0B;QAC1BO,qBAAqB,EAAE,IAAI;QAC3BF,KAAK,EAAEH,aAAa;QACpBF,KAAK,EAAE,GAAG;KACX;CACF,CAAC;AAEF,OAAO,SAASQ,aAAa,CAACC,KAAa,EAAE,EAAEC,IAAI,CAAA,EAAET,cAAc,CAAA,EAAsB,EAAU;IACjG,MAAMU,gBAAgB,GAA6B;QACjDC,KAAK,EAAE,SAAS;QAChBC,WAAW,EAAE,IAAI;KAClB,AAAC;IAEF,IAAIjB,gBAAgB,CAACK,cAAc,CAAC,EAAE;QACpCU,gBAAgB,CAACG,qBAAqB,GAAGjB,kBAAkB,CAACI,cAAc,CAAC,CAAC;QAC5EU,gBAAgB,CAACI,qBAAqB,GAAGlB,kBAAkB,CAACI,cAAc,CAAC,CAAC;IAC9E,OAAO;QACLU,gBAAgB,CAACK,wBAAwB,GAAGrB,sBAAsB,CAAC;IACrE,CAAC;IAED,oEAAoE;IACpE,IAAIe,IAAI,KAAK,SAAS,EAAE;QACtBD,KAAK,GAAGA,KAAK,GAAG,GAAG,CAAC;IACtB,CAAC;IAED,MAAMQ,SAAS,GAAGC,IAAI,CAACC,YAAY,CAAC,OAAO,EAAER,gBAAgB,CAAC,AAAC;IAC/D,OAAOM,SAAS,CAACG,MAAM,CAACX,KAAK,CAAC,CAAC;AACjC,CAAC"}

package/dist/model/units/time.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"time.d.ts","sourceRoot":"","sources":["../../../src/model/units/time.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAGtD,QAAA,MAAM,aAAa,8FAA+F,CAAC;AACnH,aAAK,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AACnD,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,YAAY,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,eAG/B,CAAC;AACF,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,CAiCvE,CAAC;AAIF,oBAAY,oBAAoB;IAC9B,YAAY,gBAAgB;IAC5B,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,KAAK,SAAS;IACd,IAAI,QAAQ;IACZ,KAAK,SAAS;IACd,MAAM,UAAU;IAChB,KAAK,SAAS;CACf;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,eAAe,GAAG,MAAM,CAiB3F"}
+{"version":3,"file":"time.d.ts","sourceRoot":"","sources":["../../../src/model/units/time.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAGtD,QAAA,MAAM,aAAa,8FAA+F,CAAC;AACnH,aAAK,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AACnD,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,YAAY,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,eAG/B,CAAC;AACF,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,CAiCvE,CAAC;AAIF,oBAAY,oBAAoB;IAC9B,YAAY,gBAAgB;IAC5B,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,KAAK,SAAS;IACd,IAAI,QAAQ;IACZ,KAAK,SAAS;IACd,MAAM,UAAU;IAChB,KAAK,SAAS;CACf;AAwDD,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,eAAe,GAAG,MAAM,CAoB3F"}

package/dist/model/units/time.js

@@ -72,12 +72,64 @@ export var PersesTimeToIntlTime;
     PersesTimeToIntlTime["Months"] = 'month';
     PersesTimeToIntlTime["Years"] = 'year';
 })(PersesTimeToIntlTime || (PersesTimeToIntlTime = {}));
+/**
+ * Note: This conversion will not be exactly accurate for months and years,
+ * due variations in the lengths of months (i.e. 28 - 31 days) and years (i.e. leap years).
+ * For precision with months and years, we would need more complex algorithms and/or external libraries.
+ * However, we expect that measurements in months and years will be rare.
+ */ const TIME_UNITS_IN_SECONDS = {
+    Years: 31536000,
+    Months: 2592000,
+    Weeks: 604800,
+    Days: 86400,
+    Hours: 3600,
+    Minutes: 60,
+    Seconds: 1,
+    Milliseconds: 0.001
+};
+const LARGEST_TO_SMALLEST_TIME_UNITS = [
+    'Years',
+    'Months',
+    'Weeks',
+    'Days',
+    'Hours',
+    'Minutes',
+    'Seconds',
+    'Milliseconds'
+];
+/**
+ * Choose the first time unit that produces a number greater than 1, starting from the biggest time unit.
+ */ function getValueAndKindForNaturalNumbers(value, kind) {
+    const valueInSeconds = value * TIME_UNITS_IN_SECONDS[kind];
+    // Initialize for TS
+    const largestTimeUnit = LARGEST_TO_SMALLEST_TIME_UNITS[0] || 'Years';
+    let timeUnit = largestTimeUnit;
+    let valueInTimeUnit = valueInSeconds / TIME_UNITS_IN_SECONDS[largestTimeUnit];
+    for (timeUnit of LARGEST_TO_SMALLEST_TIME_UNITS){
+        valueInTimeUnit = valueInSeconds / TIME_UNITS_IN_SECONDS[timeUnit];
+        if (valueInTimeUnit >= 1) {
+            return {
+                value: valueInTimeUnit,
+                kind: timeUnit
+            };
+        }
+    }
+    // If we didn't find a time unit, we have to settle for the smallest time unit (which is the last time unit).
+    return {
+        value: valueInTimeUnit,
+        kind: timeUnit
+    };
+}
+function isMonthOrYear(kind) {
+    return kind === 'Months' || kind === 'Years';
+}
 export function formatTime(value, { kind , decimal_places  }) {
-    const isMonthOrYear = kind === 'Months' || kind === 'Years';
+    if (value === 0) return '0s';
+    const results = getValueAndKindForNaturalNumbers(value, kind);
     const formatterOptions = {
         style: 'unit',
-        unit: PersesTimeToIntlTime[kind],
-        unitDisplay: isMonthOrYear ? 'long' : 'narrow'
+        unit: PersesTimeToIntlTime[results.kind],
+        unitDisplay: isMonthOrYear(results.kind) ? 'long' : 'narrow'
     };
     if (hasDecimalPlaces(decimal_places)) {
         formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);
@@ -85,7 +137,8 @@ export function formatTime(value, { kind , decimal_places  }) {
     } else {
         formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;
     }
-    return Intl.NumberFormat('en-US', formatterOptions).format(value);
+    const formatter = Intl.NumberFormat('en-US', formatterOptions);
+    return formatter.format(results.value);
 }
 
 //# sourceMappingURL=time.js.map

package/dist/model/units/time.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/model/units/time.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 { MAX_SIGNIFICANT_DIGITS } from './constants';\nimport { UnitGroupConfig, UnitConfig } from './types';\nimport { hasDecimalPlaces, limitDecimalPlaces } from './utils';\n\nconst timeUnitKinds = ['Milliseconds', 'Seconds', 'Minutes', 'Hours', 'Days', 'Weeks', 'Months', 'Years'] as const;\ntype TimeUnitKind = (typeof timeUnitKinds)[number];\nexport type TimeUnitOptions = {\n  kind: TimeUnitKind;\n  decimal_places?: number;\n};\nconst TIME_GROUP = 'Time';\nexport const TIME_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Time',\n  decimal_places: true,\n};\nexport const TIME_UNIT_CONFIG: Readonly<Record<TimeUnitKind, UnitConfig>> = {\n  Milliseconds: {\n    group: TIME_GROUP,\n    label: 'Milliseconds',\n  },\n  Seconds: {\n    group: TIME_GROUP,\n    label: 'Seconds',\n  },\n  Minutes: {\n    group: TIME_GROUP,\n    label: 'Minutes',\n  },\n  Hours: {\n    group: TIME_GROUP,\n    label: 'Hours',\n  },\n  Days: {\n    group: TIME_GROUP,\n    label: 'Days',\n  },\n  Weeks: {\n    group: TIME_GROUP,\n    label: 'Weeks',\n  },\n  Months: {\n    group: TIME_GROUP,\n    label: 'Months',\n  },\n  Years: {\n    group: TIME_GROUP,\n    label: 'Years',\n  },\n};\n\n// Mapping of time units to what Intl.NumberFormat formatter expects\n// https://v8.dev/features/intl-numberformat#units\nexport enum PersesTimeToIntlTime {\n  Milliseconds = 'millisecond',\n  Seconds = 'second',\n  Minutes = 'minute',\n  Hours = 'hour',\n  Days = 'day',\n  Weeks = 'week',\n  Months = 'month',\n  Years = 'year',\n}\n\nexport function formatTime(value: number, { kind, decimal_places }: TimeUnitOptions): string {\n  const isMonthOrYear = kind === 'Months' || kind === 'Years';\n\n  const formatterOptions: Intl.NumberFormatOptions = {\n    style: 'unit',\n    unit: PersesTimeToIntlTime[kind],\n    unitDisplay: isMonthOrYear ? 'long' : 'narrow',\n  };\n\n  if (hasDecimalPlaces(decimal_places)) {\n    formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);\n    formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimal_places);\n  } else {\n    formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;\n  }\n\n  return Intl.NumberFormat('en-US', formatterOptions).format(value);\n}\n"],"names":["MAX_SIGNIFICANT_DIGITS","hasDecimalPlaces","limitDecimalPlaces","timeUnitKinds","TIME_GROUP","TIME_GROUP_CONFIG","label","decimal_places","TIME_UNIT_CONFIG","Milliseconds","group","Seconds","Minutes","Hours","Days","Weeks","Months","Years","PersesTimeToIntlTime","formatTime","value","kind","isMonthOrYear","formatterOptions","style","unit","unitDisplay","minimumFractionDigits","maximumFractionDigits","maximumSignificantDigits","Intl","NumberFormat","format"],"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,sBAAsB,QAAQ,aAAa,CAAC;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,QAAQ,SAAS,CAAC;AAE/D,MAAMC,aAAa,GAAG;IAAC,cAAc;IAAE,SAAS;IAAE,SAAS;IAAE,OAAO;IAAE,MAAM;IAAE,OAAO;IAAE,QAAQ;IAAE,OAAO;CAAC,AAAS,AAAC;AAMnH,MAAMC,UAAU,GAAG,MAAM,AAAC;AAC1B,OAAO,MAAMC,iBAAiB,GAAoB;IAChDC,KAAK,EAAE,MAAM;IACbC,cAAc,EAAE,IAAI;CACrB,CAAC;AACF,OAAO,MAAMC,gBAAgB,GAA+C;IAC1EC,YAAY,EAAE;QACZC,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,cAAc;KACtB;IACDK,OAAO,EAAE;QACPD,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,SAAS;KACjB;IACDM,OAAO,EAAE;QACPF,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,SAAS;KACjB;IACDO,KAAK,EAAE;QACLH,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,OAAO;KACf;IACDQ,IAAI,EAAE;QACJJ,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,MAAM;KACd;IACDS,KAAK,EAAE;QACLL,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,OAAO;KACf;IACDU,MAAM,EAAE;QACNN,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,QAAQ;KAChB;IACDW,KAAK,EAAE;QACLP,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,OAAO;KACf;CACF,CAAC;WAIK,oBASN;UATWY,oBAAoB;IAApBA,oBAAoB,CAC9BT,cAAY,IAAG,aAAa;IADlBS,oBAAoB,CAE9BP,SAAO,IAAG,QAAQ;IAFRO,oBAAoB,CAG9BN,SAAO,IAAG,QAAQ;IAHRM,oBAAoB,CAI9BL,OAAK,IAAG,MAAM;IAJJK,oBAAoB,CAK9BJ,MAAI,IAAG,KAAK;IALFI,oBAAoB,CAM9BH,OAAK,IAAG,MAAM;IANJG,oBAAoB,CAO9BF,QAAM,IAAG,OAAO;IAPNE,oBAAoB,CAQ9BD,OAAK,IAAG,MAAM;GARJC,oBAAoB,KAApBA,oBAAoB;AAWhC,OAAO,SAASC,UAAU,CAACC,KAAa,EAAE,EAAEC,IAAI,CAAA,EAAEd,cAAc,CAAA,EAAmB,EAAU;IAC3F,MAAMe,aAAa,GAAGD,IAAI,KAAK,QAAQ,IAAIA,IAAI,KAAK,OAAO,AAAC;IAE5D,MAAME,gBAAgB,GAA6B;QACjDC,KAAK,EAAE,MAAM;QACbC,IAAI,EAAEP,oBAAoB,CAACG,IAAI,CAAC;QAChCK,WAAW,EAAEJ,aAAa,GAAG,MAAM,GAAG,QAAQ;KAC/C,AAAC;IAEF,IAAIrB,gBAAgB,CAACM,cAAc,CAAC,EAAE;QACpCgB,gBAAgB,CAACI,qBAAqB,GAAGzB,kBAAkB,CAACK,cAAc,CAAC,CAAC;QAC5EgB,gBAAgB,CAACK,qBAAqB,GAAG1B,kBAAkB,CAACK,cAAc,CAAC,CAAC;IAC9E,OAAO;QACLgB,gBAAgB,CAACM,wBAAwB,GAAG7B,sBAAsB,CAAC;IACrE,CAAC;IAED,OAAO8B,IAAI,CAACC,YAAY,CAAC,OAAO,EAAER,gBAAgB,CAAC,CAACS,MAAM,CAACZ,KAAK,CAAC,CAAC;AACpE,CAAC"}
+{"version":3,"sources":["../../../src/model/units/time.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 { MAX_SIGNIFICANT_DIGITS } from './constants';\nimport { UnitGroupConfig, UnitConfig } from './types';\nimport { hasDecimalPlaces, limitDecimalPlaces } from './utils';\n\nconst timeUnitKinds = ['Milliseconds', 'Seconds', 'Minutes', 'Hours', 'Days', 'Weeks', 'Months', 'Years'] as const;\ntype TimeUnitKind = (typeof timeUnitKinds)[number];\nexport type TimeUnitOptions = {\n  kind: TimeUnitKind;\n  decimal_places?: number;\n};\nconst TIME_GROUP = 'Time';\nexport const TIME_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Time',\n  decimal_places: true,\n};\nexport const TIME_UNIT_CONFIG: Readonly<Record<TimeUnitKind, UnitConfig>> = {\n  Milliseconds: {\n    group: TIME_GROUP,\n    label: 'Milliseconds',\n  },\n  Seconds: {\n    group: TIME_GROUP,\n    label: 'Seconds',\n  },\n  Minutes: {\n    group: TIME_GROUP,\n    label: 'Minutes',\n  },\n  Hours: {\n    group: TIME_GROUP,\n    label: 'Hours',\n  },\n  Days: {\n    group: TIME_GROUP,\n    label: 'Days',\n  },\n  Weeks: {\n    group: TIME_GROUP,\n    label: 'Weeks',\n  },\n  Months: {\n    group: TIME_GROUP,\n    label: 'Months',\n  },\n  Years: {\n    group: TIME_GROUP,\n    label: 'Years',\n  },\n};\n\n// Mapping of time units to what Intl.NumberFormat formatter expects\n// https://v8.dev/features/intl-numberformat#units\nexport enum PersesTimeToIntlTime {\n  Milliseconds = 'millisecond',\n  Seconds = 'second',\n  Minutes = 'minute',\n  Hours = 'hour',\n  Days = 'day',\n  Weeks = 'week',\n  Months = 'month',\n  Years = 'year',\n}\n\n/**\n * Note: This conversion will not be exactly accurate for months and years,\n * due variations in the lengths of months (i.e. 28 - 31 days) and years (i.e. leap years).\n * For precision with months and years, we would need more complex algorithms and/or external libraries.\n * However, we expect that measurements in months and years will be rare.\n */\nconst TIME_UNITS_IN_SECONDS: Record<TimeUnitKind, number> = {\n  Years: 31536000, // 365 days\n  Months: 2592000, // 30 days\n  Weeks: 604800,\n  Days: 86400,\n  Hours: 3600,\n  Minutes: 60,\n  Seconds: 1,\n  Milliseconds: 0.001,\n};\n\nconst LARGEST_TO_SMALLEST_TIME_UNITS: TimeUnitKind[] = [\n  'Years',\n  'Months',\n  'Weeks',\n  'Days',\n  'Hours',\n  'Minutes',\n  'Seconds',\n  'Milliseconds',\n];\n\n/**\n * Choose the first time unit that produces a number greater than 1, starting from the biggest time unit.\n */\nfunction getValueAndKindForNaturalNumbers(value: number, kind: TimeUnitKind): { value: number; kind: TimeUnitKind } {\n  const valueInSeconds = value * TIME_UNITS_IN_SECONDS[kind];\n\n  // Initialize for TS\n  const largestTimeUnit = LARGEST_TO_SMALLEST_TIME_UNITS[0] || 'Years';\n  let timeUnit: TimeUnitKind = largestTimeUnit;\n  let valueInTimeUnit: number = valueInSeconds / TIME_UNITS_IN_SECONDS[largestTimeUnit];\n\n  for (timeUnit of LARGEST_TO_SMALLEST_TIME_UNITS) {\n    valueInTimeUnit = valueInSeconds / TIME_UNITS_IN_SECONDS[timeUnit];\n    if (valueInTimeUnit >= 1) {\n      return { value: valueInTimeUnit, kind: timeUnit };\n    }\n  }\n\n  // If we didn't find a time unit, we have to settle for the smallest time unit (which is the last time unit).\n  return { value: valueInTimeUnit, kind: timeUnit };\n}\n\nfunction isMonthOrYear(kind: TimeUnitKind): boolean {\n  return kind === 'Months' || kind === 'Years';\n}\n\nexport function formatTime(value: number, { kind, decimal_places }: TimeUnitOptions): string {\n  if (value === 0) return '0s';\n\n  const results = getValueAndKindForNaturalNumbers(value, kind);\n\n  const formatterOptions: Intl.NumberFormatOptions = {\n    style: 'unit',\n    unit: PersesTimeToIntlTime[results.kind],\n    unitDisplay: isMonthOrYear(results.kind) ? 'long' : 'narrow',\n  };\n\n  if (hasDecimalPlaces(decimal_places)) {\n    formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);\n    formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimal_places);\n  } else {\n    formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;\n  }\n\n  const formatter = Intl.NumberFormat('en-US', formatterOptions);\n  return formatter.format(results.value);\n}\n"],"names":["MAX_SIGNIFICANT_DIGITS","hasDecimalPlaces","limitDecimalPlaces","timeUnitKinds","TIME_GROUP","TIME_GROUP_CONFIG","label","decimal_places","TIME_UNIT_CONFIG","Milliseconds","group","Seconds","Minutes","Hours","Days","Weeks","Months","Years","PersesTimeToIntlTime","TIME_UNITS_IN_SECONDS","LARGEST_TO_SMALLEST_TIME_UNITS","getValueAndKindForNaturalNumbers","value","kind","valueInSeconds","largestTimeUnit","timeUnit","valueInTimeUnit","isMonthOrYear","formatTime","results","formatterOptions","style","unit","unitDisplay","minimumFractionDigits","maximumFractionDigits","maximumSignificantDigits","formatter","Intl","NumberFormat","format"],"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,sBAAsB,QAAQ,aAAa,CAAC;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,QAAQ,SAAS,CAAC;AAE/D,MAAMC,aAAa,GAAG;IAAC,cAAc;IAAE,SAAS;IAAE,SAAS;IAAE,OAAO;IAAE,MAAM;IAAE,OAAO;IAAE,QAAQ;IAAE,OAAO;CAAC,AAAS,AAAC;AAMnH,MAAMC,UAAU,GAAG,MAAM,AAAC;AAC1B,OAAO,MAAMC,iBAAiB,GAAoB;IAChDC,KAAK,EAAE,MAAM;IACbC,cAAc,EAAE,IAAI;CACrB,CAAC;AACF,OAAO,MAAMC,gBAAgB,GAA+C;IAC1EC,YAAY,EAAE;QACZC,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,cAAc;KACtB;IACDK,OAAO,EAAE;QACPD,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,SAAS;KACjB;IACDM,OAAO,EAAE;QACPF,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,SAAS;KACjB;IACDO,KAAK,EAAE;QACLH,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,OAAO;KACf;IACDQ,IAAI,EAAE;QACJJ,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,MAAM;KACd;IACDS,KAAK,EAAE;QACLL,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,OAAO;KACf;IACDU,MAAM,EAAE;QACNN,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,QAAQ;KAChB;IACDW,KAAK,EAAE;QACLP,KAAK,EAAEN,UAAU;QACjBE,KAAK,EAAE,OAAO;KACf;CACF,CAAC;WAIK,oBASN;UATWY,oBAAoB;IAApBA,oBAAoB,CAC9BT,cAAY,IAAG,aAAa;IADlBS,oBAAoB,CAE9BP,SAAO,IAAG,QAAQ;IAFRO,oBAAoB,CAG9BN,SAAO,IAAG,QAAQ;IAHRM,oBAAoB,CAI9BL,OAAK,IAAG,MAAM;IAJJK,oBAAoB,CAK9BJ,MAAI,IAAG,KAAK;IALFI,oBAAoB,CAM9BH,OAAK,IAAG,MAAM;IANJG,oBAAoB,CAO9BF,QAAM,IAAG,OAAO;IAPNE,oBAAoB,CAQ9BD,OAAK,IAAG,MAAM;GARJC,oBAAoB,KAApBA,oBAAoB;AAWhC;;;;;CAKC,GACD,MAAMC,qBAAqB,GAAiC;IAC1DF,KAAK,EAAE,QAAQ;IACfD,MAAM,EAAE,OAAO;IACfD,KAAK,EAAE,MAAM;IACbD,IAAI,EAAE,KAAK;IACXD,KAAK,EAAE,IAAI;IACXD,OAAO,EAAE,EAAE;IACXD,OAAO,EAAE,CAAC;IACVF,YAAY,EAAE,KAAK;CACpB,AAAC;AAEF,MAAMW,8BAA8B,GAAmB;IACrD,OAAO;IACP,QAAQ;IACR,OAAO;IACP,MAAM;IACN,OAAO;IACP,SAAS;IACT,SAAS;IACT,cAAc;CACf,AAAC;AAEF;;CAEC,GACD,SAASC,gCAAgC,CAACC,KAAa,EAAEC,IAAkB,EAAyC;IAClH,MAAMC,cAAc,GAAGF,KAAK,GAAGH,qBAAqB,CAACI,IAAI,CAAC,AAAC;IAE3D,oBAAoB;IACpB,MAAME,eAAe,GAAGL,8BAA8B,CAAC,CAAC,CAAC,IAAI,OAAO,AAAC;IACrE,IAAIM,QAAQ,GAAiBD,eAAe,AAAC;IAC7C,IAAIE,eAAe,GAAWH,cAAc,GAAGL,qBAAqB,CAACM,eAAe,CAAC,AAAC;IAEtF,KAAKC,QAAQ,IAAIN,8BAA8B,CAAE;QAC/CO,eAAe,GAAGH,cAAc,GAAGL,qBAAqB,CAACO,QAAQ,CAAC,CAAC;QACnE,IAAIC,eAAe,IAAI,CAAC,EAAE;YACxB,OAAO;gBAAEL,KAAK,EAAEK,eAAe;gBAAEJ,IAAI,EAAEG,QAAQ;aAAE,CAAC;QACpD,CAAC;IACH,CAAC;IAED,6GAA6G;IAC7G,OAAO;QAAEJ,KAAK,EAAEK,eAAe;QAAEJ,IAAI,EAAEG,QAAQ;KAAE,CAAC;AACpD,CAAC;AAED,SAASE,aAAa,CAACL,IAAkB,EAAW;IAClD,OAAOA,IAAI,KAAK,QAAQ,IAAIA,IAAI,KAAK,OAAO,CAAC;AAC/C,CAAC;AAED,OAAO,SAASM,UAAU,CAACP,KAAa,EAAE,EAAEC,IAAI,CAAA,EAAEhB,cAAc,CAAA,EAAmB,EAAU;IAC3F,IAAIe,KAAK,KAAK,CAAC,EAAE,OAAO,IAAI,CAAC;IAE7B,MAAMQ,OAAO,GAAGT,gCAAgC,CAACC,KAAK,EAAEC,IAAI,CAAC,AAAC;IAE9D,MAAMQ,gBAAgB,GAA6B;QACjDC,KAAK,EAAE,MAAM;QACbC,IAAI,EAAEf,oBAAoB,CAACY,OAAO,CAACP,IAAI,CAAC;QACxCW,WAAW,EAAEN,aAAa,CAACE,OAAO,CAACP,IAAI,CAAC,GAAG,MAAM,GAAG,QAAQ;KAC7D,AAAC;IAEF,IAAItB,gBAAgB,CAACM,cAAc,CAAC,EAAE;QACpCwB,gBAAgB,CAACI,qBAAqB,GAAGjC,kBAAkB,CAACK,cAAc,CAAC,CAAC;QAC5EwB,gBAAgB,CAACK,qBAAqB,GAAGlC,kBAAkB,CAACK,cAAc,CAAC,CAAC;IAC9E,OAAO;QACLwB,gBAAgB,CAACM,wBAAwB,GAAGrC,sBAAsB,CAAC;IACrE,CAAC;IAED,MAAMsC,SAAS,GAAGC,IAAI,CAACC,YAAY,CAAC,OAAO,EAAET,gBAAgB,CAAC,AAAC;IAC/D,OAAOO,SAAS,CAACG,MAAM,CAACX,OAAO,CAACR,KAAK,CAAC,CAAC;AACzC,CAAC"}

package/dist/model/units/units.d.ts

@@ -3,6 +3,13 @@ import { DecimalUnitOptions } from './decimal';
 import { PercentUnitOptions } from './percent';
 import { TimeUnitOptions } from './time';
 import { UnitGroup, UnitGroupConfig, UnitConfig } from './types';
+/**
+ * Most of the number formatting is based on Intl.NumberFormat, which is built into JavaScript.
+ * Prefer Intl.NumbeFormat because it covers most use cases and will continue to be supported with time.
+ *
+ * To format bytes, we also make use of the `numbro` package,
+ * because it can handle adding units like KB, MB, GB, etc. correctly.
+ */
 export declare const UNIT_GROUP_CONFIG: Readonly<Record<UnitGroup, UnitGroupConfig>>;
 export declare const UNIT_CONFIG: {
     readonly Bytes: UnitConfig;

package/dist/model/units/units.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../../src/model/units/units.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,gBAAgB,EAAsD,MAAM,SAAS,CAAC;AAC/F,OAAO,EAAE,kBAAkB,EAA4D,MAAM,WAAW,CAAC;AACzG,OAAO,EAAuC,kBAAkB,EAAuB,MAAM,WAAW,CAAC;AACzG,OAAO,EAAc,eAAe,EAAuC,MAAM,QAAQ,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAEjE,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,CAK1E,CAAC;AACF,eAAO,MAAM,WAAW;;;;;;;;;;;;;;CAKd,CAAC;AAEX,oBAAY,WAAW,GAAG,eAAe,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,gBAAgB,CAAC;AAEvG,aAAK,gBAAgB,CAAC,OAAO,IAAI,OAAO,SAAS;IAAE,cAAc,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,GAAG,KAAK,CAAC;AAC/F,aAAK,aAAa,CAAC,OAAO,IAAI,OAAO,SAAS;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,GAAG,KAAK,CAAC;AAEzF,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,MAAM,CAuB5E;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,WAAW,GAAG,UAAU,CAEtE;AAED,wBAAgB,YAAY,CAAC,WAAW,EAAE,WAAW,GAAG,SAAS,CAEhE;AAED,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,eAAe,CAG5E;AAGD,wBAAgB,UAAU,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,eAAe,CAEnF;AAED,wBAAgB,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,kBAAkB,CAEzF;AAED,wBAAgB,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,kBAAkB,CAEzF;AAED,wBAAgB,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,gBAAgB,CAErF;AAED,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,gBAAgB,CAAC,WAAW,CAAC,CAI9G;AAED,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,aAAa,CAAC,WAAW,CAAC,CAIxG"}
+{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../../src/model/units/units.ts"],"names":[],"mappings":"AAaA,OAAO,EAAe,gBAAgB,EAAyC,MAAM,SAAS,CAAC;AAC/F,OAAO,EAAiB,kBAAkB,EAA6C,MAAM,WAAW,CAAC;AACzG,OAAO,EAAiB,kBAAkB,EAA6C,MAAM,WAAW,CAAC;AACzG,OAAO,EAAc,eAAe,EAAuC,MAAM,QAAQ,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAEjE;;;;;;GAMG;AAEH,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,CAK1E,CAAC;AACF,eAAO,MAAM,WAAW;;;;;;;;;;;;;;CAKd,CAAC;AAEX,oBAAY,WAAW,GAAG,eAAe,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,gBAAgB,CAAC;AAEvG,aAAK,gBAAgB,CAAC,OAAO,IAAI,OAAO,SAAS;IAAE,cAAc,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,GAAG,KAAK,CAAC;AAC/F,aAAK,aAAa,CAAC,OAAO,IAAI,OAAO,SAAS;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,GAAG,KAAK,CAAC;AAEzF,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,MAAM,CAuB5E;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,WAAW,GAAG,UAAU,CAEtE;AAED,wBAAgB,YAAY,CAAC,WAAW,EAAE,WAAW,GAAG,SAAS,CAEhE;AAED,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,eAAe,CAG5E;AAGD,wBAAgB,UAAU,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,eAAe,CAEnF;AAED,wBAAgB,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,kBAAkB,CAEzF;AAED,wBAAgB,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,kBAAkB,CAEzF;AAED,wBAAgB,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,gBAAgB,CAErF;AAED,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,gBAAgB,CAAC,WAAW,CAAC,CAI9G;AAED,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,IAAI,aAAa,CAAC,WAAW,CAAC,CAIxG"}

package/dist/model/units/units.js

@@ -10,11 +10,17 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-import { BYTES_GROUP_CONFIG, BYTES_UNIT_CONFIG, formatBytes } from './bytes';
-import { DECIMAL_UNIT_CONFIG, formatDecimal, DECIMAL_GROUP_CONFIG } from './decimal';
-import { PERCENT_GROUP_CONFIG, formatPercent, PERCENT_UNIT_CONFIG } from './percent';
+import { formatBytes, BYTES_GROUP_CONFIG, BYTES_UNIT_CONFIG } from './bytes';
+import { formatDecimal, DECIMAL_GROUP_CONFIG, DECIMAL_UNIT_CONFIG } from './decimal';
+import { formatPercent, PERCENT_GROUP_CONFIG, PERCENT_UNIT_CONFIG } from './percent';
 import { formatTime, TIME_GROUP_CONFIG, TIME_UNIT_CONFIG } from './time';
-export const UNIT_GROUP_CONFIG = {
+/**
+ * Most of the number formatting is based on Intl.NumberFormat, which is built into JavaScript.
+ * Prefer Intl.NumbeFormat because it covers most use cases and will continue to be supported with time.
+ *
+ * To format bytes, we also make use of the `numbro` package,
+ * because it can handle adding units like KB, MB, GB, etc. correctly.
+ */ export const UNIT_GROUP_CONFIG = {
     Time: TIME_GROUP_CONFIG,
     Percent: PERCENT_GROUP_CONFIG,
     Decimal: DECIMAL_GROUP_CONFIG,
@@ -30,17 +36,17 @@ export function formatValue(value, unitOptions) {
     if (unitOptions === undefined) {
         return value.toString();
     }
+    if (isBytesUnit(unitOptions)) {
+        return formatBytes(value, unitOptions);
+    }
     if (isDecimalUnit(unitOptions)) {
         return formatDecimal(value, unitOptions);
     }
-    if (isTimeUnit(unitOptions)) {
-        return formatTime(value, unitOptions);
-    }
     if (isPercentUnit(unitOptions)) {
         return formatPercent(value, unitOptions);
     }
-    if (isBytesUnit(unitOptions)) {
-        return formatBytes(value, unitOptions);
+    if (isTimeUnit(unitOptions)) {
+        return formatTime(value, unitOptions);
     }
     const exhaustive = unitOptions;
     throw new Error(`Unknown unit options ${exhaustive}`);

package/dist/model/units/units.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/model/units/units.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 { BytesUnitOptions, BYTES_GROUP_CONFIG, BYTES_UNIT_CONFIG, formatBytes } from './bytes';\nimport { DecimalUnitOptions, DECIMAL_UNIT_CONFIG, formatDecimal, DECIMAL_GROUP_CONFIG } from './decimal';\nimport { PERCENT_GROUP_CONFIG, formatPercent, PercentUnitOptions, PERCENT_UNIT_CONFIG } from './percent';\nimport { formatTime, TimeUnitOptions, TIME_GROUP_CONFIG, TIME_UNIT_CONFIG } from './time';\nimport { UnitGroup, UnitGroupConfig, UnitConfig } from './types';\n\nexport const UNIT_GROUP_CONFIG: Readonly<Record<UnitGroup, UnitGroupConfig>> = {\n  Time: TIME_GROUP_CONFIG,\n  Percent: PERCENT_GROUP_CONFIG,\n  Decimal: DECIMAL_GROUP_CONFIG,\n  Bytes: BYTES_GROUP_CONFIG,\n};\nexport const UNIT_CONFIG = {\n  ...TIME_UNIT_CONFIG,\n  ...PERCENT_UNIT_CONFIG,\n  ...DECIMAL_UNIT_CONFIG,\n  ...BYTES_UNIT_CONFIG,\n} as const;\n\nexport type UnitOptions = TimeUnitOptions | PercentUnitOptions | DecimalUnitOptions | BytesUnitOptions;\n\ntype HasDecimalPlaces<UnitOpt> = UnitOpt extends { decimal_places?: number } ? UnitOpt : never;\ntype HasAbbreviate<UnitOpt> = UnitOpt extends { abbreviate?: boolean } ? UnitOpt : never;\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    return formatBytes(value, unitOptions);\n  }\n\n  const exhaustive: never = unitOptions;\n  throw new Error(`Unknown unit options ${exhaustive}`);\n}\n\nexport function getUnitKindConfig(unitOptions: UnitOptions): UnitConfig {\n  return UNIT_CONFIG[unitOptions.kind];\n}\n\nexport function getUnitGroup(unitOptions: UnitOptions): UnitGroup {\n  return getUnitKindConfig(unitOptions).group;\n}\n\nexport function getUnitGroupConfig(unitOptions: UnitOptions): UnitGroupConfig {\n  const unitConfig = getUnitKindConfig(unitOptions);\n  return UNIT_GROUP_CONFIG[unitConfig.group];\n}\n\n// Type guards\nexport function isTimeUnit(unitOptions: UnitOptions): unitOptions is TimeUnitOptions {\n  return getUnitGroup(unitOptions) === 'Time';\n}\n\nexport function isPercentUnit(unitOptions: UnitOptions): unitOptions is PercentUnitOptions {\n  return getUnitGroup(unitOptions) === 'Percent';\n}\n\nexport function isDecimalUnit(unitOptions: UnitOptions): unitOptions is DecimalUnitOptions {\n  return getUnitGroup(unitOptions) === 'Decimal';\n}\n\nexport function isBytesUnit(unitOptions: UnitOptions): unitOptions is BytesUnitOptions {\n  return getUnitGroup(unitOptions) === 'Bytes';\n}\n\nexport function isUnitWithDecimalPlaces(unitOptions: UnitOptions): unitOptions is HasDecimalPlaces<UnitOptions> {\n  const groupConfig = getUnitGroupConfig(unitOptions);\n\n  return !!groupConfig.decimal_places;\n}\n\nexport function isUnitWithAbbreviate(unitOptions: UnitOptions): unitOptions is HasAbbreviate<UnitOptions> {\n  const groupConfig = getUnitGroupConfig(unitOptions);\n\n  return !!groupConfig.abbreviate;\n}\n"],"names":["BYTES_GROUP_CONFIG","BYTES_UNIT_CONFIG","formatBytes","DECIMAL_UNIT_CONFIG","formatDecimal","DECIMAL_GROUP_CONFIG","PERCENT_GROUP_CONFIG","formatPercent","PERCENT_UNIT_CONFIG","formatTime","TIME_GROUP_CONFIG","TIME_UNIT_CONFIG","UNIT_GROUP_CONFIG","Time","Percent","Decimal","Bytes","UNIT_CONFIG","formatValue","value","unitOptions","undefined","toString","isDecimalUnit","isTimeUnit","isPercentUnit","isBytesUnit","exhaustive","Error","getUnitKindConfig","kind","getUnitGroup","group","getUnitGroupConfig","unitConfig","isUnitWithDecimalPlaces","groupConfig","decimal_places","isUnitWithAbbreviate","abbreviate"],"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,SAA2BA,kBAAkB,EAAEC,iBAAiB,EAAEC,WAAW,QAAQ,SAAS,CAAC;AAC/F,SAA6BC,mBAAmB,EAAEC,aAAa,EAAEC,oBAAoB,QAAQ,WAAW,CAAC;AACzG,SAASC,oBAAoB,EAAEC,aAAa,EAAsBC,mBAAmB,QAAQ,WAAW,CAAC;AACzG,SAASC,UAAU,EAAmBC,iBAAiB,EAAEC,gBAAgB,QAAQ,QAAQ,CAAC;AAG1F,OAAO,MAAMC,iBAAiB,GAAiD;IAC7EC,IAAI,EAAEH,iBAAiB;IACvBI,OAAO,EAAER,oBAAoB;IAC7BS,OAAO,EAAEV,oBAAoB;IAC7BW,KAAK,EAAEhB,kBAAkB;CAC1B,CAAC;AACF,OAAO,MAAMiB,WAAW,GAAG;IACzB,GAAGN,gBAAgB;IACnB,GAAGH,mBAAmB;IACtB,GAAGL,mBAAmB;IACtB,GAAGF,iBAAiB;CACrB,AAAS,CAAC;AAOX,OAAO,SAASiB,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,OAAOhB,aAAa,CAACe,KAAK,EAAEC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,IAAII,UAAU,CAACJ,WAAW,CAAC,EAAE;QAC3B,OAAOX,UAAU,CAACU,KAAK,EAAEC,WAAW,CAAC,CAAC;IACxC,CAAC;IAED,IAAIK,aAAa,CAACL,WAAW,CAAC,EAAE;QAC9B,OAAOb,aAAa,CAACY,KAAK,EAAEC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,IAAIM,WAAW,CAACN,WAAW,CAAC,EAAE;QAC5B,OAAOlB,WAAW,CAACiB,KAAK,EAAEC,WAAW,CAAC,CAAC;IACzC,CAAC;IAED,MAAMO,UAAU,GAAUP,WAAW,AAAC;IACtC,MAAM,IAAIQ,KAAK,CAAC,CAAC,qBAAqB,EAAED,UAAU,CAAC,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,OAAO,SAASE,iBAAiB,CAACT,WAAwB,EAAc;IACtE,OAAOH,WAAW,CAACG,WAAW,CAACU,IAAI,CAAC,CAAC;AACvC,CAAC;AAED,OAAO,SAASC,YAAY,CAACX,WAAwB,EAAa;IAChE,OAAOS,iBAAiB,CAACT,WAAW,CAAC,CAACY,KAAK,CAAC;AAC9C,CAAC;AAED,OAAO,SAASC,kBAAkB,CAACb,WAAwB,EAAmB;IAC5E,MAAMc,UAAU,GAAGL,iBAAiB,CAACT,WAAW,CAAC,AAAC;IAClD,OAAOR,iBAAiB,CAACsB,UAAU,CAACF,KAAK,CAAC,CAAC;AAC7C,CAAC;AAED,cAAc;AACd,OAAO,SAASR,UAAU,CAACJ,WAAwB,EAAkC;IACnF,OAAOW,YAAY,CAACX,WAAW,CAAC,KAAK,MAAM,CAAC;AAC9C,CAAC;AAED,OAAO,SAASK,aAAa,CAACL,WAAwB,EAAqC;IACzF,OAAOW,YAAY,CAACX,WAAW,CAAC,KAAK,SAAS,CAAC;AACjD,CAAC;AAED,OAAO,SAASG,aAAa,CAACH,WAAwB,EAAqC;IACzF,OAAOW,YAAY,CAACX,WAAW,CAAC,KAAK,SAAS,CAAC;AACjD,CAAC;AAED,OAAO,SAASM,WAAW,CAACN,WAAwB,EAAmC;IACrF,OAAOW,YAAY,CAACX,WAAW,CAAC,KAAK,OAAO,CAAC;AAC/C,CAAC;AAED,OAAO,SAASe,uBAAuB,CAACf,WAAwB,EAAgD;IAC9G,MAAMgB,WAAW,GAAGH,kBAAkB,CAACb,WAAW,CAAC,AAAC;IAEpD,OAAO,CAAC,CAACgB,WAAW,CAACC,cAAc,CAAC;AACtC,CAAC;AAED,OAAO,SAASC,oBAAoB,CAAClB,WAAwB,EAA6C;IACxG,MAAMgB,WAAW,GAAGH,kBAAkB,CAACb,WAAW,CAAC,AAAC;IAEpD,OAAO,CAAC,CAACgB,WAAW,CAACG,UAAU,CAAC;AAClC,CAAC"}
+{"version":3,"sources":["../../../src/model/units/units.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 { formatBytes, BytesUnitOptions, BYTES_GROUP_CONFIG, BYTES_UNIT_CONFIG } from './bytes';\nimport { formatDecimal, DecimalUnitOptions, DECIMAL_GROUP_CONFIG, DECIMAL_UNIT_CONFIG } from './decimal';\nimport { formatPercent, PercentUnitOptions, PERCENT_GROUP_CONFIG, PERCENT_UNIT_CONFIG } from './percent';\nimport { formatTime, TimeUnitOptions, TIME_GROUP_CONFIG, TIME_UNIT_CONFIG } from './time';\nimport { UnitGroup, UnitGroupConfig, UnitConfig } from './types';\n\n/**\n * Most of the number formatting is based on Intl.NumberFormat, which is built into JavaScript.\n * Prefer Intl.NumbeFormat because it covers most use cases and will continue to be supported with time.\n *\n * To format bytes, we also make use of the `numbro` package,\n * because it can handle adding units like KB, MB, GB, etc. correctly.\n */\n\nexport const UNIT_GROUP_CONFIG: Readonly<Record<UnitGroup, UnitGroupConfig>> = {\n  Time: TIME_GROUP_CONFIG,\n  Percent: PERCENT_GROUP_CONFIG,\n  Decimal: DECIMAL_GROUP_CONFIG,\n  Bytes: BYTES_GROUP_CONFIG,\n};\nexport const UNIT_CONFIG = {\n  ...TIME_UNIT_CONFIG,\n  ...PERCENT_UNIT_CONFIG,\n  ...DECIMAL_UNIT_CONFIG,\n  ...BYTES_UNIT_CONFIG,\n} as const;\n\nexport type UnitOptions = TimeUnitOptions | PercentUnitOptions | DecimalUnitOptions | BytesUnitOptions;\n\ntype HasDecimalPlaces<UnitOpt> = UnitOpt extends { decimal_places?: number } ? UnitOpt : never;\ntype HasAbbreviate<UnitOpt> = UnitOpt extends { abbreviate?: boolean } ? UnitOpt : never;\n\nexport function formatValue(value: number, unitOptions?: UnitOptions): string {\n  if (unitOptions === undefined) {\n    return value.toString();\n  }\n\n  if (isBytesUnit(unitOptions)) {\n    return formatBytes(value, unitOptions);\n  }\n\n  if (isDecimalUnit(unitOptions)) {\n    return formatDecimal(value, unitOptions);\n  }\n\n  if (isPercentUnit(unitOptions)) {\n    return formatPercent(value, unitOptions);\n  }\n\n  if (isTimeUnit(unitOptions)) {\n    return formatTime(value, unitOptions);\n  }\n\n  const exhaustive: never = unitOptions;\n  throw new Error(`Unknown unit options ${exhaustive}`);\n}\n\nexport function getUnitKindConfig(unitOptions: UnitOptions): UnitConfig {\n  return UNIT_CONFIG[unitOptions.kind];\n}\n\nexport function getUnitGroup(unitOptions: UnitOptions): UnitGroup {\n  return getUnitKindConfig(unitOptions).group;\n}\n\nexport function getUnitGroupConfig(unitOptions: UnitOptions): UnitGroupConfig {\n  const unitConfig = getUnitKindConfig(unitOptions);\n  return UNIT_GROUP_CONFIG[unitConfig.group];\n}\n\n// Type guards\nexport function isTimeUnit(unitOptions: UnitOptions): unitOptions is TimeUnitOptions {\n  return getUnitGroup(unitOptions) === 'Time';\n}\n\nexport function isPercentUnit(unitOptions: UnitOptions): unitOptions is PercentUnitOptions {\n  return getUnitGroup(unitOptions) === 'Percent';\n}\n\nexport function isDecimalUnit(unitOptions: UnitOptions): unitOptions is DecimalUnitOptions {\n  return getUnitGroup(unitOptions) === 'Decimal';\n}\n\nexport function isBytesUnit(unitOptions: UnitOptions): unitOptions is BytesUnitOptions {\n  return getUnitGroup(unitOptions) === 'Bytes';\n}\n\nexport function isUnitWithDecimalPlaces(unitOptions: UnitOptions): unitOptions is HasDecimalPlaces<UnitOptions> {\n  const groupConfig = getUnitGroupConfig(unitOptions);\n\n  return !!groupConfig.decimal_places;\n}\n\nexport function isUnitWithAbbreviate(unitOptions: UnitOptions): unitOptions is HasAbbreviate<UnitOptions> {\n  const groupConfig = getUnitGroupConfig(unitOptions);\n\n  return !!groupConfig.abbreviate;\n}\n"],"names":["formatBytes","BYTES_GROUP_CONFIG","BYTES_UNIT_CONFIG","formatDecimal","DECIMAL_GROUP_CONFIG","DECIMAL_UNIT_CONFIG","formatPercent","PERCENT_GROUP_CONFIG","PERCENT_UNIT_CONFIG","formatTime","TIME_GROUP_CONFIG","TIME_UNIT_CONFIG","UNIT_GROUP_CONFIG","Time","Percent","Decimal","Bytes","UNIT_CONFIG","formatValue","value","unitOptions","undefined","toString","isBytesUnit","isDecimalUnit","isPercentUnit","isTimeUnit","exhaustive","Error","getUnitKindConfig","kind","getUnitGroup","group","getUnitGroupConfig","unitConfig","isUnitWithDecimalPlaces","groupConfig","decimal_places","isUnitWithAbbreviate","abbreviate"],"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,EAAoBC,kBAAkB,EAAEC,iBAAiB,QAAQ,SAAS,CAAC;AAC/F,SAASC,aAAa,EAAsBC,oBAAoB,EAAEC,mBAAmB,QAAQ,WAAW,CAAC;AACzG,SAASC,aAAa,EAAsBC,oBAAoB,EAAEC,mBAAmB,QAAQ,WAAW,CAAC;AACzG,SAASC,UAAU,EAAmBC,iBAAiB,EAAEC,gBAAgB,QAAQ,QAAQ,CAAC;AAG1F;;;;;;CAMC,GAED,OAAO,MAAMC,iBAAiB,GAAiD;IAC7EC,IAAI,EAAEH,iBAAiB;IACvBI,OAAO,EAAEP,oBAAoB;IAC7BQ,OAAO,EAAEX,oBAAoB;IAC7BY,KAAK,EAAEf,kBAAkB;CAC1B,CAAC;AACF,OAAO,MAAMgB,WAAW,GAAG;IACzB,GAAGN,gBAAgB;IACnB,GAAGH,mBAAmB;IACtB,GAAGH,mBAAmB;IACtB,GAAGH,iBAAiB;CACrB,AAAS,CAAC;AAOX,OAAO,SAASgB,WAAW,CAACC,KAAa,EAAEC,WAAyB,EAAU;IAC5E,IAAIA,WAAW,KAAKC,SAAS,EAAE;QAC7B,OAAOF,KAAK,CAACG,QAAQ,EAAE,CAAC;IAC1B,CAAC;IAED,IAAIC,WAAW,CAACH,WAAW,CAAC,EAAE;QAC5B,OAAOpB,WAAW,CAACmB,KAAK,EAAEC,WAAW,CAAC,CAAC;IACzC,CAAC;IAED,IAAII,aAAa,CAACJ,WAAW,CAAC,EAAE;QAC9B,OAAOjB,aAAa,CAACgB,KAAK,EAAEC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,IAAIK,aAAa,CAACL,WAAW,CAAC,EAAE;QAC9B,OAAOd,aAAa,CAACa,KAAK,EAAEC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,IAAIM,UAAU,CAACN,WAAW,CAAC,EAAE;QAC3B,OAAOX,UAAU,CAACU,KAAK,EAAEC,WAAW,CAAC,CAAC;IACxC,CAAC;IAED,MAAMO,UAAU,GAAUP,WAAW,AAAC;IACtC,MAAM,IAAIQ,KAAK,CAAC,CAAC,qBAAqB,EAAED,UAAU,CAAC,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,OAAO,SAASE,iBAAiB,CAACT,WAAwB,EAAc;IACtE,OAAOH,WAAW,CAACG,WAAW,CAACU,IAAI,CAAC,CAAC;AACvC,CAAC;AAED,OAAO,SAASC,YAAY,CAACX,WAAwB,EAAa;IAChE,OAAOS,iBAAiB,CAACT,WAAW,CAAC,CAACY,KAAK,CAAC;AAC9C,CAAC;AAED,OAAO,SAASC,kBAAkB,CAACb,WAAwB,EAAmB;IAC5E,MAAMc,UAAU,GAAGL,iBAAiB,CAACT,WAAW,CAAC,AAAC;IAClD,OAAOR,iBAAiB,CAACsB,UAAU,CAACF,KAAK,CAAC,CAAC;AAC7C,CAAC;AAED,cAAc;AACd,OAAO,SAASN,UAAU,CAACN,WAAwB,EAAkC;IACnF,OAAOW,YAAY,CAACX,WAAW,CAAC,KAAK,MAAM,CAAC;AAC9C,CAAC;AAED,OAAO,SAASK,aAAa,CAACL,WAAwB,EAAqC;IACzF,OAAOW,YAAY,CAACX,WAAW,CAAC,KAAK,SAAS,CAAC;AACjD,CAAC;AAED,OAAO,SAASI,aAAa,CAACJ,WAAwB,EAAqC;IACzF,OAAOW,YAAY,CAACX,WAAW,CAAC,KAAK,SAAS,CAAC;AACjD,CAAC;AAED,OAAO,SAASG,WAAW,CAACH,WAAwB,EAAmC;IACrF,OAAOW,YAAY,CAACX,WAAW,CAAC,KAAK,OAAO,CAAC;AAC/C,CAAC;AAED,OAAO,SAASe,uBAAuB,CAACf,WAAwB,EAAgD;IAC9G,MAAMgB,WAAW,GAAGH,kBAAkB,CAACb,WAAW,CAAC,AAAC;IAEpD,OAAO,CAAC,CAACgB,WAAW,CAACC,cAAc,CAAC;AACtC,CAAC;AAED,OAAO,SAASC,oBAAoB,CAAClB,WAAwB,EAA6C;IACxG,MAAMgB,WAAW,GAAGH,kBAAkB,CAACb,WAAW,CAAC,AAAC;IAEpD,OAAO,CAAC,CAACgB,WAAW,CAACG,UAAU,CAAC;AAClC,CAAC"}

package/dist/model/variables.d.ts

@@ -1,8 +1,9 @@
 import { Definition, UnknownSpec } from './definitions';
 import { Display } from './display';
+import { ProjectMetadata } from './resource';
 export declare type VariableName = string;
 export declare type VariableValue = string | string[] | null;
-interface VariableSpec {
+export interface VariableSpec {
     name: VariableName;
     display?: Display & {
         hidden?: boolean;
@@ -26,6 +27,13 @@ export interface ListVariableSpec<PluginSpec> extends VariableSpec {
     plugin: Definition<PluginSpec>;
 }
 export declare type VariableDefinition = TextVariableDefinition | ListVariableDefinition;
+/**
+ * A variable that belongs to a project.
+ */
+export interface VariableResource {
+    kind: 'Variable';
+    metadata: ProjectMetadata;
+    spec: VariableDefinition;
+}
 export declare const DEFAULT_ALL_VALUE: "$__all";
-export {};
 //# sourceMappingURL=variables.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../src/model/variables.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,oBAAY,YAAY,GAAG,MAAM,CAAC;AAElC,oBAAY,aAAa,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;AAErD,UAAU,YAAY;IACpB,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,GAAG;QAClB,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU,CAAC,gBAAgB,CAAC;IAC1E,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,sBAAsB,CAAC,UAAU,GAAG,WAAW,CAAE,SAAQ,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAChH,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB,CAAC,UAAU,CAAE,SAAQ,YAAY;IAChE,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;CAChC;AAED,oBAAY,kBAAkB,GAAG,sBAAsB,GAAG,sBAAsB,CAAC;AAEjF,eAAO,MAAM,iBAAiB,UAAoB,CAAC"}
+{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../src/model/variables.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,oBAAY,YAAY,GAAG,MAAM,CAAC;AAElC,oBAAY,aAAa,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;AAErD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,GAAG;QAClB,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU,CAAC,gBAAgB,CAAC;IAC1E,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,sBAAsB,CAAC,UAAU,GAAG,WAAW,CAAE,SAAQ,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAChH,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB,CAAC,UAAU,CAAE,SAAQ,YAAY;IAChE,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;CAChC;AAED,oBAAY,kBAAkB,GAAG,sBAAsB,GAAG,sBAAsB,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,eAAe,CAAC;IAC1B,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,eAAO,MAAM,iBAAiB,UAAoB,CAAC"}

package/dist/model/variables.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/model/variables.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 { Definition, UnknownSpec } from './definitions';\nimport { Display } from './display';\n\nexport type VariableName = string;\n\nexport type VariableValue = string | string[] | null;\n\ninterface VariableSpec {\n  name: VariableName;\n  display?: Display & {\n    hidden?: boolean;\n  };\n}\n\nexport interface TextVariableDefinition extends Definition<TextVariableSpec> {\n  kind: 'TextVariable';\n}\n\nexport interface TextVariableSpec extends VariableSpec {\n  value: string;\n}\n\nexport interface ListVariableDefinition<PluginSpec = UnknownSpec> extends Definition<ListVariableSpec<PluginSpec>> {\n  kind: 'ListVariable';\n}\n\nexport interface ListVariableSpec<PluginSpec> extends VariableSpec {\n  default_value?: VariableValue;\n  allow_multiple?: boolean;\n  allow_all_value?: boolean;\n  custom_all_value?: string;\n  capturing_regexp?: string;\n  plugin: Definition<PluginSpec>;\n}\n\nexport type VariableDefinition = TextVariableDefinition | ListVariableDefinition;\n\nexport const DEFAULT_ALL_VALUE = '$__all' as const;\n"],"names":["DEFAULT_ALL_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;AAuCjC,OAAO,MAAMA,iBAAiB,GAAG,QAAQ,AAAS,CAAC"}
+{"version":3,"sources":["../../src/model/variables.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 { Definition, UnknownSpec } from './definitions';\nimport { Display } from './display';\nimport { ProjectMetadata } from './resource';\n\nexport type VariableName = string;\n\nexport type VariableValue = string | string[] | null;\n\nexport interface VariableSpec {\n  name: VariableName;\n  display?: Display & {\n    hidden?: boolean;\n  };\n}\n\nexport interface TextVariableDefinition extends Definition<TextVariableSpec> {\n  kind: 'TextVariable';\n}\n\nexport interface TextVariableSpec extends VariableSpec {\n  value: string;\n}\n\nexport interface ListVariableDefinition<PluginSpec = UnknownSpec> extends Definition<ListVariableSpec<PluginSpec>> {\n  kind: 'ListVariable';\n}\n\nexport interface ListVariableSpec<PluginSpec> extends VariableSpec {\n  default_value?: VariableValue;\n  allow_multiple?: boolean;\n  allow_all_value?: boolean;\n  custom_all_value?: string;\n  capturing_regexp?: string;\n  plugin: Definition<PluginSpec>;\n}\n\nexport type VariableDefinition = TextVariableDefinition | ListVariableDefinition;\n\n/**\n * A variable that belongs to a project.\n */\nexport interface VariableResource {\n  kind: 'Variable';\n  metadata: ProjectMetadata;\n  spec: VariableDefinition;\n}\n\nexport const DEFAULT_ALL_VALUE = '$__all' as const;\n"],"names":["DEFAULT_ALL_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;AAiDjC,OAAO,MAAMA,iBAAiB,GAAG,QAAQ,AAAS,CAAC"}

package/dist/utils/text.d.ts

@@ -1,4 +1,38 @@
-import { DashboardResource } from '../model';
-export declare function dashboardDisplayName(dashboard: DashboardResource): string;
-export declare function dashboardExtendedDisplayName(dashboard: DashboardResource): string;
+import { Datasource, DashboardResource, VariableResource } from '../model';
+/**
+ * If the dashboard has a display name, return the dashboard display name
+ * Else, only return the dashboard name
+ * @param dashboard
+ */
+export declare function getDashboardDisplayName(dashboard: DashboardResource): string;
+/**
+ * If the variable has a display name, return the variable display name
+ * Else, only return the variable name
+ * @param variable Project or Global variable
+ */
+export declare function getVariableDisplayName(variable: VariableResource): string;
+/**
+ * If the variable has a display name, return the datasource display name
+ * Else, only return the datasource name
+ * @param variable Project or Global datasource
+ */
+export declare function getDatasourceDisplayName(datasource: Datasource): string;
+/**
+ * If the dashboard has a display name, return the dashboard display name and the dashboard name
+ * Else, only return the dashboard name
+ * @param dashboard
+ */
+export declare function getDashboardExtendedDisplayName(dashboard: DashboardResource): string;
+/**
+ * If the variable has a display name, return the variable display name and the variable name
+ * Else, only return the variable name
+ * @param variable Project or Global variable
+ */
+export declare function getVariableExtendedDisplayName(variable: VariableResource): string;
+/**
+ * If the datasource has a display name, return the datasource display name and the datasource name
+ * Else, only return the datasource name
+ * @param variable Project or Global datasource
+ */
+export declare function getDatasourceExtendedDisplayName(datasource: Datasource): string;
 //# sourceMappingURL=text.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../src/utils/text.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,iBAAiB,UAEhE;AAED,wBAAgB,4BAA4B,CAAC,SAAS,EAAE,iBAAiB,UAKxE"}
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../src/utils/text.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE3E;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,iBAAiB,UAEnE;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,gBAAgB,UAEhE;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,UAAU,UAE9D;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,CAAC,SAAS,EAAE,iBAAiB,UAK3E;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,gBAAgB,UAKxE;AAED;;;;GAIG;AACH,wBAAgB,gCAAgC,CAAC,UAAU,EAAE,UAAU,UAKtE"}

package/dist/utils/text.js

@@ -10,16 +10,64 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-export function dashboardDisplayName(dashboard) {
+/**
+ * If the dashboard has a display name, return the dashboard display name
+ * Else, only return the dashboard name
+ * @param dashboard
+ */ export function getDashboardDisplayName(dashboard) {
     var ref;
-    return ((ref = dashboard.spec.display) === null || ref === void 0 ? void 0 : ref.name) || dashboard.metadata.name;
+    var ref1;
+    return (ref1 = (ref = dashboard.spec.display) === null || ref === void 0 ? void 0 : ref.name) !== null && ref1 !== void 0 ? ref1 : dashboard.metadata.name;
 }
-export function dashboardExtendedDisplayName(dashboard) {
+/**
+ * If the variable has a display name, return the variable display name
+ * Else, only return the variable name
+ * @param variable Project or Global variable
+ */ export function getVariableDisplayName(variable) {
+    var ref;
+    var ref1;
+    return (ref1 = (ref = variable.spec.spec.display) === null || ref === void 0 ? void 0 : ref.name) !== null && ref1 !== void 0 ? ref1 : variable.metadata.name;
+}
+/**
+ * If the variable has a display name, return the datasource display name
+ * Else, only return the datasource name
+ * @param variable Project or Global datasource
+ */ export function getDatasourceDisplayName(datasource) {
+    var ref;
+    return ((ref = datasource.spec.display) === null || ref === void 0 ? void 0 : ref.name) || datasource.metadata.name;
+}
+/**
+ * If the dashboard has a display name, return the dashboard display name and the dashboard name
+ * Else, only return the dashboard name
+ * @param dashboard
+ */ export function getDashboardExtendedDisplayName(dashboard) {
     var ref;
     if ((ref = dashboard.spec.display) === null || ref === void 0 ? void 0 : ref.name) {
-        return `${dashboard.spec.display.name} (ID: ${dashboard.metadata.name})`;
+        return `${dashboard.spec.display.name} (Name: ${dashboard.metadata.name})`;
     }
     return dashboard.metadata.name;
 }
+/**
+ * If the variable has a display name, return the variable display name and the variable name
+ * Else, only return the variable name
+ * @param variable Project or Global variable
+ */ export function getVariableExtendedDisplayName(variable) {
+    var ref;
+    if ((ref = variable.spec.spec.display) === null || ref === void 0 ? void 0 : ref.name) {
+        return `${variable.spec.spec.display.name} (Name: ${variable.metadata.name})`;
+    }
+    return variable.metadata.name;
+}
+/**
+ * If the datasource has a display name, return the datasource display name and the datasource name
+ * Else, only return the datasource name
+ * @param variable Project or Global datasource
+ */ export function getDatasourceExtendedDisplayName(datasource) {
+    var ref;
+    if ((ref = datasource.spec.display) === null || ref === void 0 ? void 0 : ref.name) {
+        return `${datasource.spec.display.name} (ID: ${datasource.metadata.name})`;
+    }
+    return datasource.metadata.name;
+}
 
 //# sourceMappingURL=text.js.map

package/dist/utils/text.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/text.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 { DashboardResource } from '../model';\n\nexport function dashboardDisplayName(dashboard: DashboardResource) {\n  return dashboard.spec.display?.name || dashboard.metadata.name;\n}\n\nexport function dashboardExtendedDisplayName(dashboard: DashboardResource) {\n  if (dashboard.spec.display?.name) {\n    return `${dashboard.spec.display.name} (ID: ${dashboard.metadata.name})`;\n  }\n  return dashboard.metadata.name;\n}\n"],"names":["dashboardDisplayName","dashboard","spec","display","name","metadata","dashboardExtendedDisplayName"],"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;AAIjC,OAAO,SAASA,oBAAoB,CAACC,SAA4B,EAAE;QAC1DA,GAAsB;IAA7B,OAAOA,CAAAA,CAAAA,GAAsB,GAAtBA,SAAS,CAACC,IAAI,CAACC,OAAO,cAAtBF,GAAsB,WAAM,GAA5BA,KAAAA,CAA4B,GAA5BA,GAAsB,CAAEG,IAAI,CAAA,IAAIH,SAAS,CAACI,QAAQ,CAACD,IAAI,CAAC;AACjE,CAAC;AAED,OAAO,SAASE,4BAA4B,CAACL,SAA4B,EAAE;QACrEA,GAAsB;IAA1B,IAAIA,CAAAA,GAAsB,GAAtBA,SAAS,CAACC,IAAI,CAACC,OAAO,cAAtBF,GAAsB,WAAM,GAA5BA,KAAAA,CAA4B,GAA5BA,GAAsB,CAAEG,IAAI,EAAE;QAChC,OAAO,CAAC,EAAEH,SAAS,CAACC,IAAI,CAACC,OAAO,CAACC,IAAI,CAAC,MAAM,EAAEH,SAAS,CAACI,QAAQ,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3E,CAAC;IACD,OAAOH,SAAS,CAACI,QAAQ,CAACD,IAAI,CAAC;AACjC,CAAC"}
+{"version":3,"sources":["../../src/utils/text.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 { Datasource, DashboardResource, VariableResource } from '../model';\n\n/**\n * If the dashboard has a display name, return the dashboard display name\n * Else, only return the dashboard name\n * @param dashboard\n */\nexport function getDashboardDisplayName(dashboard: DashboardResource) {\n  return dashboard.spec.display?.name ?? dashboard.metadata.name;\n}\n\n/**\n * If the variable has a display name, return the variable display name\n * Else, only return the variable name\n * @param variable Project or Global variable\n */\nexport function getVariableDisplayName(variable: VariableResource) {\n  return variable.spec.spec.display?.name ?? variable.metadata.name;\n}\n\n/**\n * If the variable has a display name, return the datasource display name\n * Else, only return the datasource name\n * @param variable Project or Global datasource\n */\nexport function getDatasourceDisplayName(datasource: Datasource) {\n  return datasource.spec.display?.name || datasource.metadata.name;\n}\n\n/**\n * If the dashboard has a display name, return the dashboard display name and the dashboard name\n * Else, only return the dashboard name\n * @param dashboard\n */\nexport function getDashboardExtendedDisplayName(dashboard: DashboardResource) {\n  if (dashboard.spec.display?.name) {\n    return `${dashboard.spec.display.name} (Name: ${dashboard.metadata.name})`;\n  }\n  return dashboard.metadata.name;\n}\n\n/**\n * If the variable has a display name, return the variable display name and the variable name\n * Else, only return the variable name\n * @param variable Project or Global variable\n */\nexport function getVariableExtendedDisplayName(variable: VariableResource) {\n  if (variable.spec.spec.display?.name) {\n    return `${variable.spec.spec.display.name} (Name: ${variable.metadata.name})`;\n  }\n  return variable.metadata.name;\n}\n\n/**\n * If the datasource has a display name, return the datasource display name and the datasource name\n * Else, only return the datasource name\n * @param variable Project or Global datasource\n */\nexport function getDatasourceExtendedDisplayName(datasource: Datasource) {\n  if (datasource.spec.display?.name) {\n    return `${datasource.spec.display.name} (ID: ${datasource.metadata.name})`;\n  }\n  return datasource.metadata.name;\n}\n"],"names":["getDashboardDisplayName","dashboard","spec","display","name","metadata","getVariableDisplayName","variable","getDatasourceDisplayName","datasource","getDashboardExtendedDisplayName","getVariableExtendedDisplayName","getDatasourceExtendedDisplayName"],"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;AAIjC;;;;CAIC,GACD,OAAO,SAASA,uBAAuB,CAACC,SAA4B,EAAE;QAC7DA,GAAsB;QAAtBA,IAA4B;IAAnC,OAAOA,CAAAA,IAA4B,GAA5BA,CAAAA,GAAsB,GAAtBA,SAAS,CAACC,IAAI,CAACC,OAAO,cAAtBF,GAAsB,WAAM,GAA5BA,KAAAA,CAA4B,GAA5BA,GAAsB,CAAEG,IAAI,cAA5BH,IAA4B,cAA5BA,IAA4B,GAAIA,SAAS,CAACI,QAAQ,CAACD,IAAI,CAAC;AACjE,CAAC;AAED;;;;CAIC,GACD,OAAO,SAASE,sBAAsB,CAACC,QAA0B,EAAE;QAC1DA,GAA0B;QAA1BA,IAAgC;IAAvC,OAAOA,CAAAA,IAAgC,GAAhCA,CAAAA,GAA0B,GAA1BA,QAAQ,CAACL,IAAI,CAACA,IAAI,CAACC,OAAO,cAA1BI,GAA0B,WAAM,GAAhCA,KAAAA,CAAgC,GAAhCA,GAA0B,CAAEH,IAAI,cAAhCG,IAAgC,cAAhCA,IAAgC,GAAIA,QAAQ,CAACF,QAAQ,CAACD,IAAI,CAAC;AACpE,CAAC;AAED;;;;CAIC,GACD,OAAO,SAASI,wBAAwB,CAACC,UAAsB,EAAE;QACxDA,GAAuB;IAA9B,OAAOA,CAAAA,CAAAA,GAAuB,GAAvBA,UAAU,CAACP,IAAI,CAACC,OAAO,cAAvBM,GAAuB,WAAM,GAA7BA,KAAAA,CAA6B,GAA7BA,GAAuB,CAAEL,IAAI,CAAA,IAAIK,UAAU,CAACJ,QAAQ,CAACD,IAAI,CAAC;AACnE,CAAC;AAED;;;;CAIC,GACD,OAAO,SAASM,+BAA+B,CAACT,SAA4B,EAAE;QACxEA,GAAsB;IAA1B,IAAIA,CAAAA,GAAsB,GAAtBA,SAAS,CAACC,IAAI,CAACC,OAAO,cAAtBF,GAAsB,WAAM,GAA5BA,KAAAA,CAA4B,GAA5BA,GAAsB,CAAEG,IAAI,EAAE;QAChC,OAAO,CAAC,EAAEH,SAAS,CAACC,IAAI,CAACC,OAAO,CAACC,IAAI,CAAC,QAAQ,EAAEH,SAAS,CAACI,QAAQ,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IACD,OAAOH,SAAS,CAACI,QAAQ,CAACD,IAAI,CAAC;AACjC,CAAC;AAED;;;;CAIC,GACD,OAAO,SAASO,8BAA8B,CAACJ,QAA0B,EAAE;QACrEA,GAA0B;IAA9B,IAAIA,CAAAA,GAA0B,GAA1BA,QAAQ,CAACL,IAAI,CAACA,IAAI,CAACC,OAAO,cAA1BI,GAA0B,WAAM,GAAhCA,KAAAA,CAAgC,GAAhCA,GAA0B,CAAEH,IAAI,EAAE;QACpC,OAAO,CAAC,EAAEG,QAAQ,CAACL,IAAI,CAACA,IAAI,CAACC,OAAO,CAACC,IAAI,CAAC,QAAQ,EAAEG,QAAQ,CAACF,QAAQ,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC;IAChF,CAAC;IACD,OAAOG,QAAQ,CAACF,QAAQ,CAACD,IAAI,CAAC;AAChC,CAAC;AAED;;;;CAIC,GACD,OAAO,SAASQ,gCAAgC,CAACH,UAAsB,EAAE;QACnEA,GAAuB;IAA3B,IAAIA,CAAAA,GAAuB,GAAvBA,UAAU,CAACP,IAAI,CAACC,OAAO,cAAvBM,GAAuB,WAAM,GAA7BA,KAAAA,CAA6B,GAA7BA,GAAuB,CAAEL,IAAI,EAAE;QACjC,OAAO,CAAC,EAAEK,UAAU,CAACP,IAAI,CAACC,OAAO,CAACC,IAAI,CAAC,MAAM,EAAEK,UAAU,CAACJ,QAAQ,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IACD,OAAOK,UAAU,CAACJ,QAAQ,CAACD,IAAI,CAAC;AAClC,CAAC"}

package/dist/utils/time-series-data.d.ts

@@ -12,6 +12,7 @@ export declare function getXValues(timeScale: TimeScale): number[];
  */
 export declare function getTimeSeriesValues(series: TimeSeries, timeScale: TimeScale): TimeSeriesValueTuple[];
 /**
+ * [DEPRECATED] Used for legacy LineChart 'category' axis approach.
  * Given a TimeSeries from a query and a common time scale (see `getCommonTimeScale`),
  * gets the values for the y axis of a graph, filling in any timestamps that are
  * missing from the time series data with `null` values.

package/dist/utils/time-series-data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"time-series-data.d.ts","sourceRoot":"","sources":["../../src/utils/time-series-data.ts"],"names":[],"mappings":"AAaA,OAAO,EAAqB,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAG1G,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC;;;GAGG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,EAAE,CAQzD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,0BAyB3E;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAuBzF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,SAAS,CAAC,GACzE,SAAS,GAAG,SAAS,CAgFvB"}
+{"version":3,"file":"time-series-data.d.ts","sourceRoot":"","sources":["../../src/utils/time-series-data.ts"],"names":[],"mappings":"AAaA,OAAO,EAAqB,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAG1G,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC;;;GAGG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,EAAE,CAQzD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,0BAyB3E;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAuBzF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,SAAS,CAAC,GACzE,SAAS,GAAG,SAAS,CAgFvB"}

package/dist/utils/time-series-data.js

@@ -59,6 +59,7 @@ export const MIN_STEP_INTERVAL_MS = 10;
     return processedValues;
 }
 /**
+ * [DEPRECATED] Used for legacy LineChart 'category' axis approach.
  * Given a TimeSeries from a query and a common time scale (see `getCommonTimeScale`),
  * gets the values for the y axis of a graph, filling in any timestamps that are
  * missing from the time series data with `null` values.