@perses-dev/core 0.0.0-snapshot-panel-extra-content-3-17f9c42 → 0.0.0-snapshot-scatterplot-fix-imports-95e1b59

package/dist/model/units/throughput.js

@@ -0,0 +1,94 @@
+// Copyright 2023 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// 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 { MAX_SIGNIFICANT_DIGITS } from './constants';
+import { hasDecimalPlaces, limitDecimalPlaces, shouldShortenValues } from './utils';
+const throughputUnits = [
+    'counts/sec',
+    'events/sec',
+    'messages/sec',
+    'ops/sec',
+    'packets/sec',
+    'reads/sec',
+    'records/sec',
+    'requests/sec',
+    'rows/sec',
+    'writes/sec'
+];
+export const THROUGHPUT_GROUP_CONFIG = {
+    label: 'Throughput',
+    decimalPlaces: true
+};
+const THROUGHPUT_GROUP = 'Throughput';
+export const THROUGHPUT_UNIT_CONFIG = {
+    'counts/sec': {
+        group: THROUGHPUT_GROUP,
+        label: 'Counts/sec'
+    },
+    'events/sec': {
+        group: THROUGHPUT_GROUP,
+        label: 'Events/sec'
+    },
+    'messages/sec': {
+        group: THROUGHPUT_GROUP,
+        label: 'Messages/sec'
+    },
+    'ops/sec': {
+        group: THROUGHPUT_GROUP,
+        label: 'Ops/sec'
+    },
+    'packets/sec': {
+        group: THROUGHPUT_GROUP,
+        label: 'Packets/sec'
+    },
+    'reads/sec': {
+        group: THROUGHPUT_GROUP,
+        label: 'Reads/sec'
+    },
+    'requests/sec': {
+        group: THROUGHPUT_GROUP,
+        label: 'Requests/sec'
+    },
+    'records/sec': {
+        group: THROUGHPUT_GROUP,
+        label: 'Records/sec'
+    },
+    'rows/sec': {
+        group: THROUGHPUT_GROUP,
+        label: 'Rows/sec'
+    },
+    'writes/sec': {
+        group: THROUGHPUT_GROUP,
+        label: 'Writes/sec'
+    }
+};
+export function formatThroughput(value, { unit, shortValues, decimalPlaces }) {
+    const formatterOptions = {
+        style: 'decimal',
+        useGrouping: true
+    };
+    if (shouldShortenValues(shortValues)) {
+        formatterOptions.notation = 'compact';
+    }
+    if (hasDecimalPlaces(decimalPlaces)) {
+        formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimalPlaces);
+        formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimalPlaces);
+    } else {
+        if (shouldShortenValues(shortValues)) {
+            formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;
+        }
+    }
+    const formatter = Intl.NumberFormat('en-US', formatterOptions);
+    return formatter.format(value) + ' ' + unit;
+}
+
+//# sourceMappingURL=throughput.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/model/units/throughput.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 throughputUnits = [\n  'counts/sec',\n  'events/sec',\n  'messages/sec',\n  'ops/sec',\n  'packets/sec',\n  'reads/sec',\n  'records/sec',\n  'requests/sec',\n  'rows/sec',\n  'writes/sec',\n] as const;\ntype ThroughputUnit = (typeof throughputUnits)[number];\nexport type ThroughputFormatOptions = {\n  unit: ThroughputUnit;\n  decimalPlaces?: number;\n  shortValues?: boolean;\n};\nexport const THROUGHPUT_GROUP_CONFIG: UnitGroupConfig = {\n  label: 'Throughput',\n  decimalPlaces: true,\n};\nconst THROUGHPUT_GROUP = 'Throughput';\nexport const THROUGHPUT_UNIT_CONFIG: Readonly<Record<ThroughputUnit, UnitConfig>> = {\n  'counts/sec': {\n    group: THROUGHPUT_GROUP,\n    label: 'Counts/sec',\n  },\n  'events/sec': {\n    group: THROUGHPUT_GROUP,\n    label: 'Events/sec',\n  },\n  'messages/sec': {\n    group: THROUGHPUT_GROUP,\n    label: 'Messages/sec',\n  },\n  'ops/sec': {\n    group: THROUGHPUT_GROUP,\n    label: 'Ops/sec',\n  },\n  'packets/sec': {\n    group: THROUGHPUT_GROUP,\n    label: 'Packets/sec',\n  },\n  'reads/sec': {\n    group: THROUGHPUT_GROUP,\n    label: 'Reads/sec',\n  },\n  'requests/sec': {\n    group: THROUGHPUT_GROUP,\n    label: 'Requests/sec',\n  },\n  'records/sec': {\n    group: THROUGHPUT_GROUP,\n    label: 'Records/sec',\n  },\n  'rows/sec': {\n    group: THROUGHPUT_GROUP,\n    label: 'Rows/sec',\n  },\n  'writes/sec': {\n    group: THROUGHPUT_GROUP,\n    label: 'Writes/sec',\n  },\n};\n\nexport function formatThroughput(value: number, { unit, shortValues, decimalPlaces }: ThroughputFormatOptions): 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) + ' ' + unit;\n}\n"],"names":["MAX_SIGNIFICANT_DIGITS","hasDecimalPlaces","limitDecimalPlaces","shouldShortenValues","throughputUnits","THROUGHPUT_GROUP_CONFIG","label","decimalPlaces","THROUGHPUT_GROUP","THROUGHPUT_UNIT_CONFIG","group","formatThroughput","value","unit","shortValues","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,kBAAkB;IACtB;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACD;AAOD,OAAO,MAAMC,0BAA2C;IACtDC,OAAO;IACPC,eAAe;AACjB,EAAE;AACF,MAAMC,mBAAmB;AACzB,OAAO,MAAMC,yBAAuE;IAClF,cAAc;QACZC,OAAOF;QACPF,OAAO;IACT;IACA,cAAc;QACZI,OAAOF;QACPF,OAAO;IACT;IACA,gBAAgB;QACdI,OAAOF;QACPF,OAAO;IACT;IACA,WAAW;QACTI,OAAOF;QACPF,OAAO;IACT;IACA,eAAe;QACbI,OAAOF;QACPF,OAAO;IACT;IACA,aAAa;QACXI,OAAOF;QACPF,OAAO;IACT;IACA,gBAAgB;QACdI,OAAOF;QACPF,OAAO;IACT;IACA,eAAe;QACbI,OAAOF;QACPF,OAAO;IACT;IACA,YAAY;QACVI,OAAOF;QACPF,OAAO;IACT;IACA,cAAc;QACZI,OAAOF;QACPF,OAAO;IACT;AACF,EAAE;AAEF,OAAO,SAASK,iBAAiBC,KAAa,EAAE,EAAEC,IAAI,EAAEC,WAAW,EAAEP,aAAa,EAA2B;IAC3G,MAAMQ,mBAA6C;QACjDC,OAAO;QACPC,aAAa;IACf;IAEA,IAAId,oBAAoBW,cAAc;QACpCC,iBAAiBG,QAAQ,GAAG;IAC9B;IAEA,IAAIjB,iBAAiBM,gBAAgB;QACnCQ,iBAAiBI,qBAAqB,GAAGjB,mBAAmBK;QAC5DQ,iBAAiBK,qBAAqB,GAAGlB,mBAAmBK;IAC9D,OAAO;QACL,IAAIJ,oBAAoBW,cAAc;YACpCC,iBAAiBM,wBAAwB,GAAGrB;QAC9C;IACF;IAEA,MAAMsB,YAAYC,KAAKC,YAAY,CAAC,SAAST;IAC7C,OAAOO,UAAUG,MAAM,CAACb,SAAS,MAAMC;AACzC"}

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"];
+type TimeUnits = (typeof timeUnits)[number];
+export 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,KAAK,SAAS,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAC5C,MAAM,MAAM,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;;UAIUY;;;;;;;;;GAAAA,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,IAAI,EAAEhB,aAAa,EAAqB;IAClF,IAAIe,UAAU,GAAG,OAAO;IAExB,MAAMQ,UAAUT,iCAAiCC,OAAOC;IAExD,MAAMQ,mBAA6C;QACjDC,OAAO;QACPT,MAAML,oBAAoB,CAACY,QAAQP,IAAI,CAAC;QACxCU,aAAaL,cAAcE,QAAQP,IAAI,IAAI,SAAS;IACtD;IAEA,IAAItB,iBAAiBM,gBAAgB;QACnCwB,iBAAiBG,qBAAqB,GAAGhC,mBAAmBK;QAC5DwB,iBAAiBI,qBAAqB,GAAGjC,mBAAmBK;IAC9D,OAAO;QACLwB,iBAAiBK,wBAAwB,GAAGpC;IAC9C;IAEA,MAAMqC,YAAYC,KAAKC,YAAY,CAAC,SAASR;IAC7C,OAAOM,UAAUG,MAAM,CAACV,QAAQR,KAAK;AACvC"}

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

@@ -1,10 +1,11 @@
-import { UnitOptions } from './units';
-export declare const UNIT_GROUPS: readonly ["Time", "Percent", "Decimal", "Bytes"];
-export declare type UnitGroup = (typeof UNIT_GROUPS)[number];
+import { AbsoluteTimeRange, DurationString } from '../time';
+import { FormatOptions } from './units';
+export declare const UNIT_GROUPS: readonly ["Time", "Percent", "Decimal", "Bytes", "Throughput"];
+export type UnitGroup = (typeof UNIT_GROUPS)[number];
 /**
  * Configuration for rendering units that are part of a group.
  */
-export declare type UnitGroupConfig = {
+export type UnitGroupConfig = {
     /**
      * The label that is shown in the UI.
      */
@@ -12,16 +13,16 @@ 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.
  */
-export declare type UnitConfig = {
+export type UnitConfig = {
     /**
      * The group the unit is part of. This will inform common rendering behavior.
      */
@@ -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,gEAAiE,CAAC;AAC1F,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,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,MAAM,MAAM,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

@@ -16,7 +16,8 @@ export const UNIT_GROUPS = [
     'Time',
     'Percent',
     'Decimal',
-    'Bytes'
+    'Bytes',
+    'Throughput'
 ];
 
 //# sourceMappingURL=types.js.map

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', 'Throughput'] 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;IAAS;CAAa,CAAU"}

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

@@ -1,40 +1,59 @@
-import { BytesUnitOptions } from './bytes';
-import { DecimalUnitOptions } from './decimal';
-import { PercentUnitOptions } from './percent';
-import { TimeUnitOptions } from './time';
+import { BytesFormatOptions as BytesFormatOptions } from './bytes';
+import { DecimalFormatOptions as DecimalFormatOptions } from './decimal';
+import { PercentFormatOptions as PercentFormatOptions } from './percent';
+import { TimeFormatOptions as TimeFormatOptions } from './time';
 import { UnitGroup, UnitGroupConfig, UnitConfig } from './types';
+import { ThroughputFormatOptions } from './throughput';
+/**
+ * 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;
-    readonly Decimal: UnitConfig;
-    readonly Percent: UnitConfig;
-    readonly PercentDecimal: UnitConfig;
+    readonly "counts/sec": UnitConfig;
+    readonly "events/sec": UnitConfig;
+    readonly "messages/sec": UnitConfig;
+    readonly "ops/sec": UnitConfig;
+    readonly "packets/sec": UnitConfig;
+    readonly "reads/sec": UnitConfig;
+    readonly "records/sec": UnitConfig;
+    readonly "requests/sec": UnitConfig;
+    readonly "rows/sec": UnitConfig;
+    readonly "writes/sec": UnitConfig;
+    readonly bytes: UnitConfig;
+    readonly decimal: UnitConfig;
+    readonly percent: UnitConfig;
+    readonly "percent-decimal": UnitConfig;
     readonly "%": UnitConfig;
-    readonly Milliseconds: UnitConfig;
-    readonly Seconds: UnitConfig;
-    readonly Minutes: UnitConfig;
-    readonly Hours: UnitConfig;
-    readonly Days: UnitConfig;
-    readonly Weeks: UnitConfig;
-    readonly Months: UnitConfig;
-    readonly Years: UnitConfig;
+    readonly milliseconds: UnitConfig;
+    readonly seconds: UnitConfig;
+    readonly minutes: UnitConfig;
+    readonly hours: UnitConfig;
+    readonly days: UnitConfig;
+    readonly weeks: UnitConfig;
+    readonly months: UnitConfig;
+    readonly years: UnitConfig;
 };
-export declare type UnitOptions = TimeUnitOptions | PercentUnitOptions | DecimalUnitOptions | BytesUnitOptions;
-declare type HasDecimalPlaces<UnitOpt> = UnitOpt extends {
-    decimal_places?: number;
+export type FormatOptions = TimeFormatOptions | PercentFormatOptions | DecimalFormatOptions | BytesFormatOptions | ThroughputFormatOptions;
+type HasDecimalPlaces<UnitOpt> = UnitOpt extends {
+    decimalPlaces?: number;
 } ? UnitOpt : never;
-declare type HasAbbreviate<UnitOpt> = UnitOpt extends {
-    abbreviate?: boolean;
+type HasShortValues<UnitOpt> = UnitOpt extends {
+    shortValues?: boolean;
 } ? UnitOpt : never;
-export declare function formatValue(value: number, unitOptions?: UnitOptions): string;
-export declare function getUnitKindConfig(unitOptions: UnitOptions): UnitConfig;
-export declare function getUnitGroup(unitOptions: UnitOptions): UnitGroup;
-export declare function getUnitGroupConfig(unitOptions: UnitOptions): UnitGroupConfig;
-export declare function isTimeUnit(unitOptions: UnitOptions): unitOptions is TimeUnitOptions;
-export declare function isPercentUnit(unitOptions: UnitOptions): unitOptions is PercentUnitOptions;
-export declare function isDecimalUnit(unitOptions: UnitOptions): unitOptions is DecimalUnitOptions;
-export declare function isBytesUnit(unitOptions: UnitOptions): unitOptions is BytesUnitOptions;
-export declare function isUnitWithDecimalPlaces(unitOptions: UnitOptions): unitOptions is HasDecimalPlaces<UnitOptions>;
-export declare function isUnitWithAbbreviate(unitOptions: UnitOptions): unitOptions is HasAbbreviate<UnitOptions>;
+export declare function formatValue(value: number, formatOptions?: FormatOptions): string;
+export declare function getUnitConfig(formatOptions: FormatOptions): UnitConfig;
+export declare function getUnitGroup(formatOptions: FormatOptions): UnitGroup;
+export declare function getUnitGroupConfig(formatOptions: FormatOptions): UnitGroupConfig;
+export declare function isTimeUnit(formatOptions: FormatOptions): formatOptions is TimeFormatOptions;
+export declare function isPercentUnit(formatOptions: FormatOptions): formatOptions is PercentFormatOptions;
+export declare function isDecimalUnit(formatOptions: FormatOptions): formatOptions is DecimalFormatOptions;
+export declare function isBytesUnit(formatOptions: FormatOptions): formatOptions is BytesFormatOptions;
+export declare function isUnitWithDecimalPlaces(formatOptions: FormatOptions): formatOptions is HasDecimalPlaces<FormatOptions>;
+export declare function isUnitWithShortValues(formatOptions: FormatOptions): formatOptions is HasShortValues<FormatOptions>;
+export declare function isThroughputUnit(formatOptions: FormatOptions): formatOptions is ThroughputFormatOptions;
 export {};
 //# sourceMappingURL=units.d.ts.map

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,kBAAkB,IAAI,kBAAkB,EAAyC,MAAM,SAAS,CAAC;AACvH,OAAO,EAEL,oBAAoB,IAAI,oBAAoB,EAG7C,MAAM,WAAW,CAAC;AACnB,OAAO,EAEL,oBAAoB,IAAI,oBAAoB,EAG7C,MAAM,WAAW,CAAC;AACnB,OAAO,EAAc,iBAAiB,IAAI,iBAAiB,EAAuC,MAAM,QAAQ,CAAC;AACjH,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,EAIL,uBAAuB,EACxB,MAAM,cAAc,CAAC;AAEtB;;;;;;GAMG;AAEH,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,CAM1E,CAAC;AACF,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;CAMd,CAAC;AAEX,MAAM,MAAM,aAAa,GACrB,iBAAiB,GACjB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,CAAC;AAE5B,KAAK,gBAAgB,CAAC,OAAO,IAAI,OAAO,SAAS;IAAE,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,GAAG,KAAK,CAAC;AAC9F,KAAK,cAAc,CAAC,OAAO,IAAI,OAAO,SAAS;IAAE,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,GAAG,KAAK,CAAC;AAE3F,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,aAAa,GAAG,MAAM,CA2BhF;AAED,wBAAgB,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,UAAU,CAEtE;AAED,wBAAgB,YAAY,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,CAEpE;AAED,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,aAAa,GAAG,eAAe,CAGhF;AAGD,wBAAgB,UAAU,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,IAAI,iBAAiB,CAE3F;AAED,wBAAgB,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,IAAI,oBAAoB,CAEjG;AAED,wBAAgB,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,IAAI,oBAAoB,CAEjG;AAED,wBAAgB,WAAW,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,IAAI,kBAAkB,CAE7F;AAED,wBAAgB,uBAAuB,CACrC,aAAa,EAAE,aAAa,GAC3B,aAAa,IAAI,gBAAgB,CAAC,aAAa,CAAC,CAIlD;AAED,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,IAAI,cAAc,CAAC,aAAa,CAAC,CAIlH;AAED,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,IAAI,uBAAuB,CAEvG"}