@perses-dev/core 0.38.0 → 0.40.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, shouldShortenValues } 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 bytesUnits = ['bytes'] as const;\ntype BytesUnit = (typeof bytesUnits)[number];\nexport type BytesFormatOptions = {\n  unit: BytesUnit;\n  decimalPlaces?: number;\n  shortValues?: boolean;\n};\nexport const BYTES_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Bytes',\n  decimalPlaces: true,\n  shortValues: true,\n};\nexport const BYTES_UNIT_CONFIG: Readonly<Record<BytesUnit, UnitConfig>> = {\n  bytes: {\n    group: 'Bytes',\n    label: 'Bytes',\n  },\n};\n\nexport function formatBytes(bytes: number, { shortValues, decimalPlaces }: BytesFormatOptions) {\n  // If we're showing the entire value, we can use Intl.NumberFormat.\n  if (!shouldShortenValues(shortValues) || 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(decimalPlaces)) {\n      formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimalPlaces);\n      formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimalPlaces);\n    } else {\n      // This can happen if bytes is between -1000 and 1000\n      if (shouldShortenValues(shortValues)) {\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 shorten 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(decimalPlaces) ? decimalPlaces : DEFAULT_NUMBRO_MANTISSA,\n    // trimMantissa trims trailing 0s\n    trimMantissa: !hasDecimalPlaces(decimalPlaces),\n    // optionalMantissa excludes all the decimal places if they're all zeros\n    optionalMantissa: !hasDecimalPlaces(decimalPlaces),\n  });\n}\n"],"names":["numbro","MAX_SIGNIFICANT_DIGITS","hasDecimalPlaces","limitDecimalPlaces","shouldShortenValues","DEFAULT_NUMBRO_MANTISSA","bytesUnits","BYTES_GROUP_CONFIG","label","decimalPlaces","shortValues","BYTES_UNIT_CONFIG","bytes","group","formatBytes","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,YAAY,SAAS;AAE5B,SAASC,sBAAsB,QAAQ,cAAc;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,EAAEC,mBAAmB,QAAQ,UAAU;AAEpF;;;;;;CAMC,GAED,MAAMC,0BAA0B;AAEhC,MAAMC,aAAa;IAAC;CAAQ;AAO5B,OAAO,MAAMC,qBAAsC;IACjDC,OAAO;IACPC,eAAe;IACfC,aAAa;AACf,EAAE;AACF,OAAO,MAAMC,oBAA6D;IACxEC,OAAO;QACLC,OAAO;QACPL,OAAO;IACT;AACF,EAAE;AAEF,OAAO,SAASM,YAAYF,KAAa,EAAE,EAAEF,YAAW,EAAED,cAAa,EAAsB;IAC3F,mEAAmE;IACnE,IAAI,CAACL,oBAAoBM,gBAAgBK,KAAKC,IAAIJ,SAAS,MAAM;QAC/D,MAAMK,mBAA6C;YACjDC,OAAO;YACPC,MAAM;YACNC,aAAa;YACbC,aAAa;QACf;QAEA,IAAInB,iBAAiBO,gBAAgB;YACnCQ,iBAAiBK,wBAAwBnB,mBAAmBM;YAC5DQ,iBAAiBM,wBAAwBpB,mBAAmBM;QAC9D,OAAO;YACL,qDAAqD;YACrD,IAAIL,oBAAoBM,cAAc;gBACpCO,iBAAiBO,2BAA2BvB;YAC9C;QACF;QACA,MAAMwB,YAAYC,KAAKC,aAAa,SAASV;QAC7C,OAAOQ,UAAUG,OAAOhB;IAC1B;IAEA,qDAAqD;IACrD,+DAA+D;IAC/D,OAAOZ,OAAOY,OAAOgB,OAAO;QAC1BC,QAAQ;QACRC,MAAM;QACNC,gBAAgB;QAChBC,UAAU9B,iBAAiBO,iBAAiBA,gBAAgBJ;QAC5D,iCAAiC;QACjC4B,cAAc,CAAC/B,iBAAiBO;QAChC,wEAAwE;QACxEyB,kBAAkB,CAAChC,iBAAiBO;IACtC;AACF"}

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/model/units/constants.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\n// Common constants needed across individual unit groups and the overall\n// combined units.\nexport const MAX_SIGNIFICANT_DIGITS = 3;\n"],"names":["MAX_SIGNIFICANT_DIGITS"],"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,wEAAwE;AACxE,kBAAkB;AAClB,OAAO,MAAMA,sBAAsB,GAAG,CAAC,CAAC"}
+{"version":3,"sources":["../../../src/model/units/constants.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\n// Common constants needed across individual unit groups and the overall\n// combined units.\nexport const MAX_SIGNIFICANT_DIGITS = 3;\n"],"names":["MAX_SIGNIFICANT_DIGITS"],"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,wEAAwE;AACxE,kBAAkB;AAClB,OAAO,MAAMA,yBAAyB,EAAE"}

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

@@ -1,13 +1,13 @@
 import { UnitGroupConfig, UnitConfig } from './types';
-declare const decimalUnitKinds: readonly ["Decimal"];
-declare type DecimalUnitKind = (typeof decimalUnitKinds)[number];
-export declare type DecimalUnitOptions = {
-    kind: DecimalUnitKind;
-    decimal_places?: number;
-    abbreviate?: boolean;
+declare const decimalUnits: readonly ["decimal"];
+declare type DecimalUnit = (typeof decimalUnits)[number];
+export declare type DecimalFormatOptions = {
+    unit: DecimalUnit;
+    decimalPlaces?: number;
+    shortValues?: boolean;
 };
 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 const DECIMAL_UNIT_CONFIG: Readonly<Record<DecimalUnit, UnitConfig>>;
+export declare function formatDecimal(value: number, { shortValues, decimalPlaces }: DecimalFormatOptions): 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,YAAY,sBAAuB,CAAC;AAC1C,aAAK,WAAW,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AACjD,oBAAY,oBAAoB,GAAG;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AACF,eAAO,MAAM,oBAAoB,EAAE,eAIlC,CAAC;AACF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,CAKzE,CAAC;AAEF,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,aAAa,EAAE,EAAE,oBAAoB,GAAG,MAAM,CAqBzG"}

package/dist/model/units/decimal.js

@@ -11,39 +11,39 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { MAX_SIGNIFICANT_DIGITS } from './constants';
-import { hasDecimalPlaces, limitDecimalPlaces, shouldAbbreviate } from './utils';
-const decimalUnitKinds = [
-    'Decimal'
+import { hasDecimalPlaces, limitDecimalPlaces, shouldShortenValues } from './utils';
+const decimalUnits = [
+    'decimal'
 ];
 export const DECIMAL_GROUP_CONFIG = {
     label: 'Decimal',
-    decimal_places: true,
-    abbreviate: true
+    decimalPlaces: true,
+    shortValues: true
 };
 export const DECIMAL_UNIT_CONFIG = {
-    Decimal: {
+    decimal: {
         group: 'Decimal',
         label: 'Decimal'
     }
 };
-export function formatDecimal(value, options) {
-    const { abbreviate , decimal_places  } = options;
+export function formatDecimal(value, { shortValues , decimalPlaces  }) {
     const formatterOptions = {
         style: 'decimal',
         useGrouping: true
     };
-    if (shouldAbbreviate(abbreviate)) {
+    if (shouldShortenValues(shortValues)) {
         formatterOptions.notation = 'compact';
     }
-    if (hasDecimalPlaces(decimal_places)) {
-        formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);
-        formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimal_places);
+    if (hasDecimalPlaces(decimalPlaces)) {
+        formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimalPlaces);
+        formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimalPlaces);
     } else {
-        if (shouldAbbreviate(abbreviate)) {
+        if (shouldShortenValues(shortValues)) {
             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, shouldShortenValues } from './utils';\n\nconst decimalUnits = ['decimal'] as const;\ntype DecimalUnit = (typeof decimalUnits)[number];\nexport type DecimalFormatOptions = {\n  unit: DecimalUnit;\n  decimalPlaces?: number;\n  shortValues?: boolean;\n};\nexport const DECIMAL_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Decimal',\n  decimalPlaces: true,\n  shortValues: true,\n};\nexport const DECIMAL_UNIT_CONFIG: Readonly<Record<DecimalUnit, UnitConfig>> = {\n  decimal: {\n    group: 'Decimal',\n    label: 'Decimal',\n  },\n};\n\nexport function formatDecimal(value: number, { shortValues, decimalPlaces }: DecimalFormatOptions): string {\n  const formatterOptions: Intl.NumberFormatOptions = {\n    style: 'decimal',\n    useGrouping: true,\n  };\n\n  if (shouldShortenValues(shortValues)) {\n    formatterOptions.notation = 'compact';\n  }\n\n  if (hasDecimalPlaces(decimalPlaces)) {\n    formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimalPlaces);\n    formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimalPlaces);\n  } else {\n    if (shouldShortenValues(shortValues)) {\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","shouldShortenValues","decimalUnits","DECIMAL_GROUP_CONFIG","label","decimalPlaces","shortValues","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,cAAc;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,EAAEC,mBAAmB,QAAQ,UAAU;AAEpF,MAAMC,eAAe;IAAC;CAAU;AAOhC,OAAO,MAAMC,uBAAwC;IACnDC,OAAO;IACPC,eAAe;IACfC,aAAa;AACf,EAAE;AACF,OAAO,MAAMC,sBAAiE;IAC5EC,SAAS;QACPC,OAAO;QACPL,OAAO;IACT;AACF,EAAE;AAEF,OAAO,SAASM,cAAcC,KAAa,EAAE,EAAEL,YAAW,EAAED,cAAa,EAAwB;IAC/F,MAAMO,mBAA6C;QACjDC,OAAO;QACPC,aAAa;IACf;IAEA,IAAIb,oBAAoBK,cAAc;QACpCM,iBAAiBG,WAAW;IAC9B;IAEA,IAAIhB,iBAAiBM,gBAAgB;QACnCO,iBAAiBI,wBAAwBhB,mBAAmBK;QAC5DO,iBAAiBK,wBAAwBjB,mBAAmBK;IAC9D,OAAO;QACL,IAAIJ,oBAAoBK,cAAc;YACpCM,iBAAiBM,2BAA2BpB;QAC9C;IACF;IAEA,MAAMqB,YAAYC,KAAKC,aAAa,SAAST;IAC7C,OAAOO,UAAUG,OAAOX;AAC1B"}

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/model/units/index.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\nexport * from './utils';\nexport * from './units';\nexport * from './constants';\nexport * from './types';\n"],"names":[],"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,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC"}
+{"version":3,"sources":["../../../src/model/units/index.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\nexport * from './utils';\nexport * from './units';\nexport * from './constants';\nexport * from './types';\n"],"names":[],"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,cAAc,UAAU;AACxB,cAAc,UAAU;AACxB,cAAc,cAAc;AAC5B,cAAc,UAAU"}

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

@@ -1,12 +1,12 @@
 import { UnitGroupConfig, UnitConfig } from './types';
-declare const percentUnitKinds: readonly ["Percent", "PercentDecimal", "%"];
-declare type PercentUnitKind = (typeof percentUnitKinds)[number];
-export declare type PercentUnitOptions = {
-    kind: PercentUnitKind;
-    decimal_places?: number;
+declare const percentUnits: readonly ["percent", "percent-decimal", "%"];
+declare type PercentUnit = (typeof percentUnits)[number];
+export declare type PercentFormatOptions = {
+    unit: PercentUnit;
+    decimalPlaces?: number;
 };
 export declare const PERCENT_GROUP_CONFIG: UnitGroupConfig;
-export declare const PERCENT_UNIT_CONFIG: Readonly<Record<PercentUnitKind, UnitConfig>>;
-export declare function formatPercent(value: number, { kind, decimal_places }: PercentUnitOptions): string;
+export declare const PERCENT_UNIT_CONFIG: Readonly<Record<PercentUnit, UnitConfig>>;
+export declare function formatPercent(value: number, { unit, decimalPlaces }: PercentFormatOptions): string;
 export {};
 //# sourceMappingURL=percent.d.ts.map

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,YAAY,8CAA+C,CAAC;AAClE,aAAK,WAAW,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AACjD,oBAAY,oBAAoB,GAAG;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AACF,eAAO,MAAM,oBAAoB,EAAE,eAGlC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,CAgBzE,CAAC;AAEF,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,oBAAoB,GAAG,MAAM,CAoBlG"}

package/dist/model/units/percent.js

@@ -12,22 +12,22 @@
 // limitations under the License.
 import { MAX_SIGNIFICANT_DIGITS } from './constants';
 import { hasDecimalPlaces, limitDecimalPlaces } from './utils';
-const percentUnitKinds = [
-    'Percent',
-    'PercentDecimal',
+const percentUnits = [
+    'percent',
+    'percent-decimal',
     '%'
 ];
 export const PERCENT_GROUP_CONFIG = {
-    label: 'Percent',
-    decimal_places: true
+    label: 'percent',
+    decimalPlaces: true
 };
 const PERCENT_GROUP = 'Percent';
 export const PERCENT_UNIT_CONFIG = {
-    Percent: {
+    percent: {
         group: PERCENT_GROUP,
         label: 'Percent (0-100)'
     },
-    PercentDecimal: {
+    'percent-decimal': {
         group: PERCENT_GROUP,
         label: 'Percent (0.0-1.0)'
     },
@@ -39,22 +39,23 @@ export const PERCENT_UNIT_CONFIG = {
         label: '%'
     }
 };
-export function formatPercent(value, { kind , decimal_places  }) {
-    // Intl.NumberFormat translates 0 -> 0%, 0.5 -> 50%, 1 -> 100%
-    if (kind === 'Percent') {
-        value = value / 100;
-    }
+export function formatPercent(value, { unit , decimalPlaces  }) {
     const formatterOptions = {
         style: 'percent',
         useGrouping: true
     };
-    if (hasDecimalPlaces(decimal_places)) {
-        formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);
-        formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimal_places);
+    if (hasDecimalPlaces(decimalPlaces)) {
+        formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimalPlaces);
+        formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimalPlaces);
     } 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 (unit === '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 percentUnits = ['percent', 'percent-decimal', '%'] as const;\ntype PercentUnit = (typeof percentUnits)[number];\nexport type PercentFormatOptions = {\n  unit: PercentUnit;\n  decimalPlaces?: number;\n};\nexport const PERCENT_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'percent',\n  decimalPlaces: true,\n};\nconst PERCENT_GROUP = 'Percent';\nexport const PERCENT_UNIT_CONFIG: Readonly<Record<PercentUnit, UnitConfig>> = {\n  percent: {\n    group: PERCENT_GROUP,\n    label: 'Percent (0-100)',\n  },\n  'percent-decimal': {\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, { unit, decimalPlaces }: PercentFormatOptions): string {\n  const formatterOptions: Intl.NumberFormatOptions = {\n    style: 'percent',\n    useGrouping: true,\n  };\n\n  if (hasDecimalPlaces(decimalPlaces)) {\n    formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimalPlaces);\n    formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimalPlaces);\n  } else {\n    formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;\n  }\n\n  // Intl.NumberFormat translates 0 -> 0%, 0.5 -> 50%, 1 -> 100%, etc.\n  if (unit === '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","percentUnits","PERCENT_GROUP_CONFIG","label","decimalPlaces","PERCENT_GROUP","PERCENT_UNIT_CONFIG","percent","group","disableSelectorOption","formatPercent","value","unit","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,cAAc;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,QAAQ,UAAU;AAE/D,MAAMC,eAAe;IAAC;IAAW;IAAmB;CAAI;AAMxD,OAAO,MAAMC,uBAAwC;IACnDC,OAAO;IACPC,eAAe;AACjB,EAAE;AACF,MAAMC,gBAAgB;AACtB,OAAO,MAAMC,sBAAiE;IAC5EC,SAAS;QACPC,OAAOH;QACPF,OAAO;IACT;IACA,mBAAmB;QACjBK,OAAOH;QACPF,OAAO;IACT;IACA,KAAK;QACH,qEAAqE;QACrE,0BAA0B;QAC1BM,uBAAuB;QACvBD,OAAOH;QACPF,OAAO;IACT;AACF,EAAE;AAEF,OAAO,SAASO,cAAcC,KAAa,EAAE,EAAEC,KAAI,EAAER,cAAa,EAAwB;IACxF,MAAMS,mBAA6C;QACjDC,OAAO;QACPC,aAAa;IACf;IAEA,IAAIhB,iBAAiBK,gBAAgB;QACnCS,iBAAiBG,wBAAwBhB,mBAAmBI;QAC5DS,iBAAiBI,wBAAwBjB,mBAAmBI;IAC9D,OAAO;QACLS,iBAAiBK,2BAA2BpB;IAC9C;IAEA,oEAAoE;IACpE,IAAIc,SAAS,WAAW;QACtBD,QAAQA,QAAQ;IAClB;IAEA,MAAMQ,YAAYC,KAAKC,aAAa,SAASR;IAC7C,OAAOM,UAAUG,OAAOX;AAC1B"}

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

@@ -1,22 +1,22 @@
 import { UnitGroupConfig, UnitConfig } from './types';
-declare const timeUnitKinds: readonly ["Milliseconds", "Seconds", "Minutes", "Hours", "Days", "Weeks", "Months", "Years"];
-declare type TimeUnitKind = (typeof timeUnitKinds)[number];
-export declare type TimeUnitOptions = {
-    kind: TimeUnitKind;
-    decimal_places?: number;
+declare const timeUnits: readonly ["milliseconds", "seconds", "minutes", "hours", "days", "weeks", "months", "years"];
+declare type TimeUnits = (typeof timeUnits)[number];
+export declare type TimeFormatOptions = {
+    unit: TimeUnits;
+    decimalPlaces?: number;
 };
 export declare const TIME_GROUP_CONFIG: UnitGroupConfig;
-export declare const TIME_UNIT_CONFIG: Readonly<Record<TimeUnitKind, UnitConfig>>;
+export declare const TIME_UNIT_CONFIG: Readonly<Record<TimeUnits, UnitConfig>>;
 export declare enum PersesTimeToIntlTime {
-    Milliseconds = "millisecond",
-    Seconds = "second",
-    Minutes = "minute",
-    Hours = "hour",
-    Days = "day",
-    Weeks = "week",
-    Months = "month",
-    Years = "year"
+    milliseconds = "millisecond",
+    seconds = "second",
+    minutes = "minute",
+    hours = "hour",
+    days = "day",
+    weeks = "week",
+    months = "month",
+    years = "year"
 }
-export declare function formatTime(value: number, { kind, decimal_places }: TimeUnitOptions): string;
+export declare function formatTime(value: number, { unit, decimalPlaces }: TimeFormatOptions): string;
 export {};
 //# sourceMappingURL=time.d.ts.map

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,SAAS,8FAA+F,CAAC;AAC/G,aAAK,SAAS,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAC5C,oBAAY,iBAAiB,GAAG;IAC9B,IAAI,EAAE,SAAS,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,eAG/B,CAAC;AACF,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,CAiCpE,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,aAAa,EAAE,EAAE,iBAAiB,GAAG,MAAM,CAoB5F"}

package/dist/model/units/time.js

@@ -12,80 +12,133 @@
 // limitations under the License.
 import { MAX_SIGNIFICANT_DIGITS } from './constants';
 import { hasDecimalPlaces, limitDecimalPlaces } from './utils';
-const timeUnitKinds = [
-    'Milliseconds',
-    'Seconds',
-    'Minutes',
-    'Hours',
-    'Days',
-    'Weeks',
-    'Months',
-    'Years'
+const timeUnits = [
+    'milliseconds',
+    'seconds',
+    'minutes',
+    'hours',
+    'days',
+    'weeks',
+    'months',
+    'years'
 ];
 const TIME_GROUP = 'Time';
 export const TIME_GROUP_CONFIG = {
     label: 'Time',
-    decimal_places: true
+    decimalPlaces: true
 };
 export const TIME_UNIT_CONFIG = {
-    Milliseconds: {
+    milliseconds: {
         group: TIME_GROUP,
         label: 'Milliseconds'
     },
-    Seconds: {
+    seconds: {
         group: TIME_GROUP,
         label: 'Seconds'
     },
-    Minutes: {
+    minutes: {
         group: TIME_GROUP,
         label: 'Minutes'
     },
-    Hours: {
+    hours: {
         group: TIME_GROUP,
         label: 'Hours'
     },
-    Days: {
+    days: {
         group: TIME_GROUP,
         label: 'Days'
     },
-    Weeks: {
+    weeks: {
         group: TIME_GROUP,
         label: 'Weeks'
     },
-    Months: {
+    months: {
         group: TIME_GROUP,
         label: 'Months'
     },
-    Years: {
+    years: {
         group: TIME_GROUP,
         label: 'Years'
     }
 };
 export var PersesTimeToIntlTime;
 (function(PersesTimeToIntlTime) {
-    PersesTimeToIntlTime["Milliseconds"] = 'millisecond';
-    PersesTimeToIntlTime["Seconds"] = 'second';
-    PersesTimeToIntlTime["Minutes"] = 'minute';
-    PersesTimeToIntlTime["Hours"] = 'hour';
-    PersesTimeToIntlTime["Days"] = 'day';
-    PersesTimeToIntlTime["Weeks"] = 'week';
-    PersesTimeToIntlTime["Months"] = 'month';
-    PersesTimeToIntlTime["Years"] = 'year';
+    PersesTimeToIntlTime["milliseconds"] = 'millisecond';
+    PersesTimeToIntlTime["seconds"] = 'second';
+    PersesTimeToIntlTime["minutes"] = 'minute';
+    PersesTimeToIntlTime["hours"] = 'hour';
+    PersesTimeToIntlTime["days"] = 'day';
+    PersesTimeToIntlTime["weeks"] = 'week';
+    PersesTimeToIntlTime["months"] = 'month';
+    PersesTimeToIntlTime["years"] = 'year';
 })(PersesTimeToIntlTime || (PersesTimeToIntlTime = {}));
-export function formatTime(value, { kind , decimal_places  }) {
-    const isMonthOrYear = kind === 'Months' || kind === 'Years';
+/**
+ * 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, unit) {
+    const valueInSeconds = value * TIME_UNITS_IN_SECONDS[unit];
+    // 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,
+                unit: 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,
+        unit: timeUnit
+    };
+}
+function isMonthOrYear(unit) {
+    return unit === 'months' || unit === 'years';
+}
+export function formatTime(value, { unit , decimalPlaces  }) {
+    if (value === 0) return '0s';
+    const results = getValueAndKindForNaturalNumbers(value, unit);
     const formatterOptions = {
         style: 'unit',
-        unit: PersesTimeToIntlTime[kind],
-        unitDisplay: isMonthOrYear ? 'long' : 'narrow'
+        unit: PersesTimeToIntlTime[results.unit],
+        unitDisplay: isMonthOrYear(results.unit) ? 'long' : 'narrow'
     };
-    if (hasDecimalPlaces(decimal_places)) {
-        formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimal_places);
-        formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimal_places);
+    if (hasDecimalPlaces(decimalPlaces)) {
+        formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimalPlaces);
+        formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimalPlaces);
     } 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 timeUnits = ['milliseconds', 'seconds', 'minutes', 'hours', 'days', 'weeks', 'months', 'years'] as const;\ntype TimeUnits = (typeof timeUnits)[number];\nexport type TimeFormatOptions = {\n  unit: TimeUnits;\n  decimalPlaces?: number;\n};\nconst TIME_GROUP = 'Time';\nexport const TIME_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Time',\n  decimalPlaces: true,\n};\nexport const TIME_UNIT_CONFIG: Readonly<Record<TimeUnits, 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<TimeUnits, number> = {\n  years: 31536000, // 365 days\n  months: 2592000, // 30 days\n  weeks: 604800, // 7 days\n  days: 86400,\n  hours: 3600,\n  minutes: 60,\n  seconds: 1,\n  milliseconds: 0.001,\n};\n\nconst LARGEST_TO_SMALLEST_TIME_UNITS: TimeUnits[] = [\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, unit: TimeUnits): { value: number; unit: TimeUnits } {\n  const valueInSeconds = value * TIME_UNITS_IN_SECONDS[unit];\n\n  // Initialize for TS\n  const largestTimeUnit = LARGEST_TO_SMALLEST_TIME_UNITS[0] || 'years';\n  let timeUnit: TimeUnits = 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, unit: 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, unit: timeUnit };\n}\n\nfunction isMonthOrYear(unit: TimeUnits): boolean {\n  return unit === 'months' || unit === 'years';\n}\n\nexport function formatTime(value: number, { unit, decimalPlaces }: TimeFormatOptions): string {\n  if (value === 0) return '0s';\n\n  const results = getValueAndKindForNaturalNumbers(value, unit);\n\n  const formatterOptions: Intl.NumberFormatOptions = {\n    style: 'unit',\n    unit: PersesTimeToIntlTime[results.unit],\n    unitDisplay: isMonthOrYear(results.unit) ? 'long' : 'narrow',\n  };\n\n  if (hasDecimalPlaces(decimalPlaces)) {\n    formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimalPlaces);\n    formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimalPlaces);\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","timeUnits","TIME_GROUP","TIME_GROUP_CONFIG","label","decimalPlaces","TIME_UNIT_CONFIG","milliseconds","group","seconds","minutes","hours","days","weeks","months","years","PersesTimeToIntlTime","TIME_UNITS_IN_SECONDS","LARGEST_TO_SMALLEST_TIME_UNITS","getValueAndKindForNaturalNumbers","value","unit","valueInSeconds","largestTimeUnit","timeUnit","valueInTimeUnit","isMonthOrYear","formatTime","results","formatterOptions","style","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,cAAc;AAErD,SAASC,gBAAgB,EAAEC,kBAAkB,QAAQ,UAAU;AAE/D,MAAMC,YAAY;IAAC;IAAgB;IAAW;IAAW;IAAS;IAAQ;IAAS;IAAU;CAAQ;AAMrG,MAAMC,aAAa;AACnB,OAAO,MAAMC,oBAAqC;IAChDC,OAAO;IACPC,eAAe;AACjB,EAAE;AACF,OAAO,MAAMC,mBAA4D;IACvEC,cAAc;QACZC,OAAON;QACPE,OAAO;IACT;IACAK,SAAS;QACPD,OAAON;QACPE,OAAO;IACT;IACAM,SAAS;QACPF,OAAON;QACPE,OAAO;IACT;IACAO,OAAO;QACLH,OAAON;QACPE,OAAO;IACT;IACAQ,MAAM;QACJJ,OAAON;QACPE,OAAO;IACT;IACAS,OAAO;QACLL,OAAON;QACPE,OAAO;IACT;IACAU,QAAQ;QACNN,OAAON;QACPE,OAAO;IACT;IACAW,OAAO;QACLP,OAAON;QACPE,OAAO;IACT;AACF,EAAE;WAIK;UAAKY,oBAAoB;IAApBA,qBACVT,kBAAe;IADLS,qBAEVP,aAAU;IAFAO,qBAGVN,aAAU;IAHAM,qBAIVL,WAAQ;IAJEK,qBAKVJ,UAAO;IALGI,qBAMVH,WAAQ;IANEG,qBAOVF,YAAS;IAPCE,qBAQVD,WAAQ;GAREC,yBAAAA;AAWZ;;;;;CAKC,GACD,MAAMC,wBAAmD;IACvDF,OAAO;IACPD,QAAQ;IACRD,OAAO;IACPD,MAAM;IACND,OAAO;IACPD,SAAS;IACTD,SAAS;IACTF,cAAc;AAChB;AAEA,MAAMW,iCAA8C;IAClD;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACD;AAED;;CAEC,GACD,SAASC,iCAAiCC,KAAa,EAAEC,IAAe;IACtE,MAAMC,iBAAiBF,QAAQH,qBAAqB,CAACI,KAAK;IAE1D,oBAAoB;IACpB,MAAME,kBAAkBL,8BAA8B,CAAC,EAAE,IAAI;IAC7D,IAAIM,WAAsBD;IAC1B,IAAIE,kBAA0BH,iBAAiBL,qBAAqB,CAACM,gBAAgB;IAErF,KAAKC,YAAYN,+BAAgC;QAC/CO,kBAAkBH,iBAAiBL,qBAAqB,CAACO,SAAS;QAClE,IAAIC,mBAAmB,GAAG;YACxB,OAAO;gBAAEL,OAAOK;gBAAiBJ,MAAMG;YAAS;QAClD;IACF;IAEA,6GAA6G;IAC7G,OAAO;QAAEJ,OAAOK;QAAiBJ,MAAMG;IAAS;AAClD;AAEA,SAASE,cAAcL,IAAe;IACpC,OAAOA,SAAS,YAAYA,SAAS;AACvC;AAEA,OAAO,SAASM,WAAWP,KAAa,EAAE,EAAEC,KAAI,EAAEhB,cAAa,EAAqB;IAClF,IAAIe,UAAU,GAAG,OAAO;IAExB,MAAMQ,UAAUT,iCAAiCC,OAAOC;IAExD,MAAMQ,mBAA6C;QACjDC,OAAO;QACPT,MAAML,oBAAoB,CAACY,QAAQP,KAAK;QACxCU,aAAaL,cAAcE,QAAQP,QAAQ,SAAS;IACtD;IAEA,IAAItB,iBAAiBM,gBAAgB;QACnCwB,iBAAiBG,wBAAwBhC,mBAAmBK;QAC5DwB,iBAAiBI,wBAAwBjC,mBAAmBK;IAC9D,OAAO;QACLwB,iBAAiBK,2BAA2BpC;IAC9C;IAEA,MAAMqC,YAAYC,KAAKC,aAAa,SAASR;IAC7C,OAAOM,UAAUG,OAAOV,QAAQR;AAClC"}

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

@@ -1,4 +1,5 @@
-import { UnitOptions } from './units';
+import { AbsoluteTimeRange, DurationString } from '../time';
+import { FormatOptions } from './units';
 export declare const UNIT_GROUPS: readonly ["Time", "Percent", "Decimal", "Bytes"];
 export declare type UnitGroup = (typeof UNIT_GROUPS)[number];
 /**
@@ -12,11 +13,11 @@ export declare type UnitGroupConfig = {
     /**
      * When true, the unit group supports setting decimal places.
      */
-    decimal_places?: boolean;
+    decimalPlaces?: boolean;
     /**
-     * When true, the unit group supports enabling abbreviate.
+     * When true, the unit group supports enabling shortValues.
      */
-    abbreviate?: boolean;
+    shortValues?: boolean;
 };
 /**
  * Configuration for rendering a specific unit.
@@ -41,7 +42,15 @@ export declare type UnitConfig = {
  */
 export interface UnitTestCase {
     value: number;
-    unit: UnitOptions;
+    format: FormatOptions;
     expected: string;
 }
+export interface IntervalTestCase {
+    timeRange: AbsoluteTimeRange;
+    expected: Duration;
+}
+export interface FormatTestCase {
+    duration: Duration;
+    expected: DurationString;
+}
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/model/units/types.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,eAAO,MAAM,WAAW,kDAAmD,CAAC;AAC5E,oBAAY,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAErD;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,oBAAY,UAAU,GAAG;IACvB;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/model/units/types.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,eAAO,MAAM,WAAW,kDAAmD,CAAC;AAC5E,oBAAY,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAErD;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,oBAAY,UAAU,GAAG;IACvB;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,iBAAiB,CAAC;IAC7B,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,cAAc,CAAC;CAC1B"}

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/model/units/types.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\n// Common types needed across individual unit groups and the overall combined\n// units.\n\nimport { UnitOptions } from './units';\n\nexport const UNIT_GROUPS = ['Time', 'Percent', 'Decimal', 'Bytes'] as const;\nexport type UnitGroup = (typeof UNIT_GROUPS)[number];\n\n/**\n * Configuration for rendering units that are part of a group.\n */\nexport type UnitGroupConfig = {\n  /**\n   * The label that is shown in the UI.\n   */\n  label: string;\n  /**\n   * When true, the unit group supports setting decimal places.\n   */\n  decimal_places?: boolean;\n  /**\n   * When true, the unit group supports enabling abbreviate.\n   */\n  abbreviate?: boolean;\n};\n\n/**\n * Configuration for rendering a specific unit.\n */\nexport type UnitConfig = {\n  /**\n   * The group the unit is part of. This will inform common rendering behavior.\n   */\n  group: UnitGroup;\n\n  /**\n   * When true, this unit will not be displayed in the unit selector. This is\n   * useful for units that are shorthand variants of other units.\n   */\n  disableSelectorOption?: boolean;\n\n  /**\n   * The label that is shown in the UI.\n   */\n  label: string;\n};\n\n/**\n * Used in the tests for each type of unit.\n */\nexport interface UnitTestCase {\n  value: number;\n  unit: UnitOptions;\n  expected: string;\n}\n"],"names":["UNIT_GROUPS"],"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,6EAA6E;AAC7E,SAAS;AAIT,OAAO,MAAMA,WAAW,GAAG;IAAC,MAAM;IAAE,SAAS;IAAE,SAAS;IAAE,OAAO;CAAC,AAAS,CAAC"}
+{"version":3,"sources":["../../../src/model/units/types.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\n// Common types needed across individual unit groups and the overall combined\n// units.\n\nimport { AbsoluteTimeRange, DurationString } from '../time';\nimport { FormatOptions } from './units';\n\nexport const UNIT_GROUPS = ['Time', 'Percent', 'Decimal', 'Bytes'] as const;\nexport type UnitGroup = (typeof UNIT_GROUPS)[number];\n\n/**\n * Configuration for rendering units that are part of a group.\n */\nexport type UnitGroupConfig = {\n  /**\n   * The label that is shown in the UI.\n   */\n  label: string;\n  /**\n   * When true, the unit group supports setting decimal places.\n   */\n  decimalPlaces?: boolean;\n  /**\n   * When true, the unit group supports enabling shortValues.\n   */\n  shortValues?: boolean;\n};\n\n/**\n * Configuration for rendering a specific unit.\n */\nexport type UnitConfig = {\n  /**\n   * The group the unit is part of. This will inform common rendering behavior.\n   */\n  group: UnitGroup;\n\n  /**\n   * When true, this unit will not be displayed in the unit selector. This is\n   * useful for units that are shorthand variants of other units.\n   */\n  disableSelectorOption?: boolean;\n\n  /**\n   * The label that is shown in the UI.\n   */\n  label: string;\n};\n\n/**\n * Used in the tests for each type of unit.\n */\nexport interface UnitTestCase {\n  value: number;\n  format: FormatOptions;\n  expected: string;\n}\n\nexport interface IntervalTestCase {\n  timeRange: AbsoluteTimeRange;\n  expected: Duration;\n}\n\nexport interface FormatTestCase {\n  duration: Duration;\n  expected: DurationString;\n}\n"],"names":["UNIT_GROUPS"],"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,6EAA6E;AAC7E,SAAS;AAKT,OAAO,MAAMA,cAAc;IAAC;IAAQ;IAAW;IAAW;CAAQ,CAAU"}