@perses-dev/components 0.54.0-beta.0 → 0.54.0-beta.1

package/dist/model/time.js

@@ -0,0 +1,158 @@
+// Copyright 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 { getFormatterFromCache } from './formatterCache';
+import { hasDecimalPlaces, limitDecimalPlaces } from './utils';
+const TIME_GROUP = 'Time';
+export const TIME_GROUP_CONFIG = {
+    label: 'Time',
+    decimalPlaces: true
+};
+export const TIME_UNIT_CONFIG = {
+    nanoseconds: {
+        group: TIME_GROUP,
+        label: 'Nanoseconds'
+    },
+    microseconds: {
+        group: TIME_GROUP,
+        label: 'Microseconds'
+    },
+    milliseconds: {
+        group: TIME_GROUP,
+        label: 'Milliseconds'
+    },
+    seconds: {
+        group: TIME_GROUP,
+        label: 'Seconds'
+    },
+    minutes: {
+        group: TIME_GROUP,
+        label: 'Minutes'
+    },
+    hours: {
+        group: TIME_GROUP,
+        label: 'Hours'
+    },
+    days: {
+        group: TIME_GROUP,
+        label: 'Days'
+    },
+    weeks: {
+        group: TIME_GROUP,
+        label: 'Weeks'
+    },
+    months: {
+        group: TIME_GROUP,
+        label: 'Months'
+    },
+    years: {
+        group: TIME_GROUP,
+        label: 'Years'
+    }
+};
+// Mapping of time units to what Intl.NumberFormat formatter expects
+// https://v8.dev/features/intl-numberformat#units
+export var PersesTimeToIntlTime = /*#__PURE__*/ function(PersesTimeToIntlTime) {
+    PersesTimeToIntlTime["nanoseconds"] = "nanosecond";
+    PersesTimeToIntlTime["microseconds"] = "microsecond";
+    PersesTimeToIntlTime["milliseconds"] = "millisecond";
+    PersesTimeToIntlTime["seconds"] = "second";
+    PersesTimeToIntlTime["minutes"] = "minute";
+    PersesTimeToIntlTime["hours"] = "hour";
+    PersesTimeToIntlTime["days"] = "day";
+    PersesTimeToIntlTime["weeks"] = "week";
+    PersesTimeToIntlTime["months"] = "month";
+    PersesTimeToIntlTime["years"] = "year";
+    return PersesTimeToIntlTime;
+}({});
+/**
+ * Note: This conversion will not be exactly accurate for months and years,
+ * due variations in the lengths of months (i.e. 28 - 31 days) and years (i.e. leap years).
+ * For precision with months and years, we would need more complex algorithms and/or external libraries.
+ * However, we expect that measurements in months and years will be rare.
+ */ const TIME_UNITS_IN_SECONDS = {
+    years: 31536000,
+    months: 2592000,
+    weeks: 604800,
+    days: 86400,
+    hours: 3600,
+    minutes: 60,
+    seconds: 1,
+    milliseconds: 0.001,
+    microseconds: 0.000001,
+    nanoseconds: 0.000000001
+};
+const LARGEST_TO_SMALLEST_TIME_UNITS = [
+    'years',
+    'months',
+    'weeks',
+    'days',
+    'hours',
+    'minutes',
+    'seconds',
+    'milliseconds',
+    'microseconds',
+    'nanoseconds'
+];
+/**
+ * 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 ?? 'seconds');
+    const formatterOptions = {
+        style: 'unit',
+        unit: PersesTimeToIntlTime[results.unit],
+        unitDisplay: isMonthOrYear(results.unit) ? 'long' : 'narrow'
+    };
+    if (hasDecimalPlaces(decimalPlaces)) {
+        formatterOptions.minimumFractionDigits = limitDecimalPlaces(decimalPlaces);
+        formatterOptions.maximumFractionDigits = limitDecimalPlaces(decimalPlaces);
+    } else {
+        formatterOptions.maximumSignificantDigits = MAX_SIGNIFICANT_DIGITS;
+    }
+    const key = [
+        formatterOptions.style,
+        formatterOptions.unit,
+        formatterOptions.unitDisplay,
+        formatterOptions.maximumSignificantDigits,
+        decimalPlaces,
+        unit ?? 'seconds'
+    ];
+    return getFormatterFromCache(key, 'time', formatterOptions, 'en-US')(results.value);
+}
+
+//# sourceMappingURL=time.js.map

package/dist/model/time.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/model/time.ts"],"sourcesContent":["// Copyright 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 { getFormatterFromCache } from './formatterCache';\nimport { UnitGroupConfig, UnitConfig } from './types';\nimport { hasDecimalPlaces, limitDecimalPlaces } from './utils';\n\ntype TimeUnits =\n  | 'nanoseconds'\n  | 'microseconds'\n  | 'milliseconds'\n  | 'seconds'\n  | 'minutes'\n  | 'hours'\n  | 'days'\n  | 'weeks'\n  | 'months'\n  | 'years';\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  nanoseconds: {\n    group: TIME_GROUP,\n    label: 'Nanoseconds',\n  },\n  microseconds: {\n    group: TIME_GROUP,\n    label: 'Microseconds',\n  },\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  nanoseconds = 'nanosecond',\n  microseconds = 'microsecond',\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  microseconds: 0.000001,\n  nanoseconds: 0.000000001,\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  'microseconds',\n  'nanoseconds',\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 ?? 'seconds');\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 key = [\n    formatterOptions.style,\n    formatterOptions.unit,\n    formatterOptions.unitDisplay,\n    formatterOptions.maximumSignificantDigits,\n    decimalPlaces,\n    unit ?? 'seconds',\n  ];\n\n  return getFormatterFromCache(key, 'time', formatterOptions, 'en-US')(results.value);\n}\n"],"names":["MAX_SIGNIFICANT_DIGITS","getFormatterFromCache","hasDecimalPlaces","limitDecimalPlaces","TIME_GROUP","TIME_GROUP_CONFIG","label","decimalPlaces","TIME_UNIT_CONFIG","nanoseconds","group","microseconds","milliseconds","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","key"],"mappings":"AAAA,+BAA+B;AAC/B,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;AACrD,SAASC,qBAAqB,QAAQ,mBAAmB;AAEzD,SAASC,gBAAgB,EAAEC,kBAAkB,QAAQ,UAAU;AAiB/D,MAAMC,aAAa;AACnB,OAAO,MAAMC,oBAAqC;IAChDC,OAAO;IACPC,eAAe;AACjB,EAAE;AACF,OAAO,MAAMC,mBAA4D;IACvEC,aAAa;QACXC,OAAON;QACPE,OAAO;IACT;IACAK,cAAc;QACZD,OAAON;QACPE,OAAO;IACT;IACAM,cAAc;QACZF,OAAON;QACPE,OAAO;IACT;IACAO,SAAS;QACPH,OAAON;QACPE,OAAO;IACT;IACAQ,SAAS;QACPJ,OAAON;QACPE,OAAO;IACT;IACAS,OAAO;QACLL,OAAON;QACPE,OAAO;IACT;IACAU,MAAM;QACJN,OAAON;QACPE,OAAO;IACT;IACAW,OAAO;QACLP,OAAON;QACPE,OAAO;IACT;IACAY,QAAQ;QACNR,OAAON;QACPE,OAAO;IACT;IACAa,OAAO;QACLT,OAAON;QACPE,OAAO;IACT;AACF,EAAE;AAEF,oEAAoE;AACpE,kDAAkD;AAClD,OAAO,IAAA,AAAKc,8CAAAA;;;;;;;;;;;WAAAA;MAWX;AAED;;;;;CAKC,GACD,MAAMC,wBAAmD;IACvDF,OAAO;IACPD,QAAQ;IACRD,OAAO;IACPD,MAAM;IACND,OAAO;IACPD,SAAS;IACTD,SAAS;IACTD,cAAc;IACdD,cAAc;IACdF,aAAa;AACf;AAEA,MAAMa,iCAA8C;IAClD;IACA;IACA;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,EAAElB,aAAa,EAAqB;IAClF,IAAIiB,UAAU,GAAG,OAAO;IAExB,MAAMQ,UAAUT,iCAAiCC,OAAOC,QAAQ;IAEhE,MAAMQ,mBAA6C;QACjDC,OAAO;QACPT,MAAML,oBAAoB,CAACY,QAAQP,IAAI,CAAC;QACxCU,aAAaL,cAAcE,QAAQP,IAAI,IAAI,SAAS;IACtD;IAEA,IAAIvB,iBAAiBK,gBAAgB;QACnC0B,iBAAiBG,qBAAqB,GAAGjC,mBAAmBI;QAC5D0B,iBAAiBI,qBAAqB,GAAGlC,mBAAmBI;IAC9D,OAAO;QACL0B,iBAAiBK,wBAAwB,GAAGtC;IAC9C;IAEA,MAAMuC,MAAM;QACVN,iBAAiBC,KAAK;QACtBD,iBAAiBR,IAAI;QACrBQ,iBAAiBE,WAAW;QAC5BF,iBAAiBK,wBAAwB;QACzC/B;QACAkB,QAAQ;KACT;IAED,OAAOxB,sBAAsBsC,KAAK,QAAQN,kBAAkB,SAASD,QAAQR,KAAK;AACpF"}

package/dist/model/transforms.d.ts

@@ -0,0 +1,43 @@
+export interface TransformCommonSpec {
+    disabled?: boolean;
+}
+export interface JoinByColumnValueTransform {
+    kind: 'JoinByColumnValue';
+    spec: TransformCommonSpec & {
+        columns: string[];
+    };
+}
+export interface ExtractColumnFieldsTransform {
+    kind: 'ExtractColumnFields';
+    spec: TransformCommonSpec & {
+        column: string;
+        format: 'JSON' | 'Regex' | 'SplitByDelimiter' | 'KeyValuePairs';
+        matcher?: string;
+    };
+}
+export interface MergeColumnsTransform {
+    kind: 'MergeColumns';
+    spec: TransformCommonSpec & {
+        columns: string[];
+        name: string;
+    };
+}
+export interface MergeIndexedColumnsTransform {
+    kind: 'MergeIndexedColumns';
+    spec: TransformCommonSpec & {
+        column: string;
+    };
+}
+export interface MergeSeriesTransform {
+    kind: 'MergeSeries';
+    spec: TransformCommonSpec;
+}
+export type Transform = JoinByColumnValueTransform | MergeColumnsTransform | MergeIndexedColumnsTransform | MergeSeriesTransform | ExtractColumnFieldsTransform;
+export declare const TRANSFORM_TEXT: {
+    JoinByColumnValue: string;
+    MergeColumns: string;
+    MergeIndexedColumns: string;
+    MergeSeries: string;
+    ExtractColumnFields: string;
+};
+//# sourceMappingURL=transforms.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transforms.d.ts","sourceRoot":"","sources":["../../src/model/transforms.ts"],"names":[],"mappings":"AAaA,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,IAAI,EAAE,mBAAmB,GAAG;QAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC;CACH;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,qBAAqB,CAAC;IAC5B,IAAI,EAAE,mBAAmB,GAAG;QAC1B,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,kBAAkB,GAAG,eAAe,CAAC;QAChE,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,mBAAmB,GAAG;QAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,qBAAqB,CAAC;IAC5B,IAAI,EAAE,mBAAmB,GAAG;QAC1B,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,MAAM,SAAS,GACjB,0BAA0B,GAC1B,qBAAqB,GACrB,4BAA4B,GAC5B,oBAAoB,GACpB,4BAA4B,CAAC;AAGjC,eAAO,MAAM,cAAc;;;;;;CAM1B,CAAC"}

package/dist/model/transforms.js

@@ -0,0 +1,22 @@
+// Copyright 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.
+// Can be moved somewhere else
+export const TRANSFORM_TEXT = {
+    JoinByColumnValue: 'Join by column value',
+    MergeColumns: 'Merge columns',
+    MergeIndexedColumns: 'Merge indexed columns',
+    MergeSeries: 'Merge series',
+    ExtractColumnFields: 'Extract column fields'
+};
+
+//# sourceMappingURL=transforms.js.map

package/dist/model/transforms.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/model/transforms.ts"],"sourcesContent":["// Copyright 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 interface TransformCommonSpec {\n  disabled?: boolean;\n}\n\nexport interface JoinByColumnValueTransform {\n  kind: 'JoinByColumnValue';\n  spec: TransformCommonSpec & {\n    columns: string[];\n  };\n}\n\nexport interface ExtractColumnFieldsTransform {\n  kind: 'ExtractColumnFields';\n  spec: TransformCommonSpec & {\n    column: string;\n    format: 'JSON' | 'Regex' | 'SplitByDelimiter' | 'KeyValuePairs';\n    matcher?: string;\n  };\n}\n\nexport interface MergeColumnsTransform {\n  kind: 'MergeColumns';\n  spec: TransformCommonSpec & {\n    columns: string[];\n    name: string;\n  };\n}\n\nexport interface MergeIndexedColumnsTransform {\n  kind: 'MergeIndexedColumns';\n  spec: TransformCommonSpec & {\n    column: string;\n  };\n}\n\nexport interface MergeSeriesTransform {\n  kind: 'MergeSeries';\n  spec: TransformCommonSpec;\n}\n\nexport type Transform =\n  | JoinByColumnValueTransform\n  | MergeColumnsTransform\n  | MergeIndexedColumnsTransform\n  | MergeSeriesTransform\n  | ExtractColumnFieldsTransform;\n\n// Can be moved somewhere else\nexport const TRANSFORM_TEXT = {\n  JoinByColumnValue: 'Join by column value',\n  MergeColumns: 'Merge columns',\n  MergeIndexedColumns: 'Merge indexed columns',\n  MergeSeries: 'Merge series',\n  ExtractColumnFields: 'Extract column fields',\n};\n"],"names":["TRANSFORM_TEXT","JoinByColumnValue","MergeColumns","MergeIndexedColumns","MergeSeries","ExtractColumnFields"],"mappings":"AAAA,+BAA+B;AAC/B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAiDjC,8BAA8B;AAC9B,OAAO,MAAMA,iBAAiB;IAC5BC,mBAAmB;IACnBC,cAAc;IACdC,qBAAqB;IACrBC,aAAa;IACbC,qBAAqB;AACvB,EAAE"}

package/dist/model/types.d.ts

@@ -0,0 +1,56 @@
+import { Duration } from 'date-fns';
+import { AbsoluteTimeRange, DurationString } from '@perses-dev/spec';
+import { FormatOptions } from './units';
+export type UnitGroup = 'Time' | 'Percent' | 'Decimal' | 'Bytes' | 'Bits' | 'Throughput' | 'Currency' | 'Temperature' | 'Date';
+/**
+ * Configuration for rendering units that are part of a group.
+ */
+export type UnitGroupConfig = {
+    /**
+     * The label that is shown in the UI.
+     */
+    label: string;
+    /**
+     * When true, the unit group supports setting decimal places.
+     */
+    decimalPlaces?: boolean;
+    /**
+     * When true, the unit group supports enabling shortValues.
+     */
+    shortValues?: boolean;
+};
+/**
+ * Configuration for rendering a specific unit.
+ */
+export type UnitConfig = {
+    /**
+     * The group the unit is part of. This will inform common rendering behavior.
+     */
+    group?: UnitGroup;
+    /**
+     * When true, this unit will not be displayed in the unit selector. This is
+     * useful for units that are shorthand variants of other units.
+     */
+    disableSelectorOption?: boolean;
+    /**
+     * The label that is shown in the UI.
+     */
+    label: string;
+};
+/**
+ * Used in the tests for each type of unit.
+ */
+export interface UnitTestCase {
+    value: number;
+    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/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/model/types.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,SAAS,GACT,SAAS,GACT,OAAO,GACP,MAAM,GACN,YAAY,GACZ,UAAU,GACV,aAAa,GACb,MAAM,CAAC;AAEX;;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,CAAC,EAAE,SAAS,CAAC;IAElB;;;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/types.js

@@ -0,0 +1,15 @@
+// Copyright 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.
+export { };
+
+//# sourceMappingURL=types.js.map

package/dist/model/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/model/types.ts"],"sourcesContent":["// Copyright The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { Duration } from 'date-fns';\nimport { AbsoluteTimeRange, DurationString } from '@perses-dev/spec';\nimport { FormatOptions } from './units';\n\nexport type UnitGroup =\n  | 'Time'\n  | 'Percent'\n  | 'Decimal'\n  | 'Bytes'\n  | 'Bits'\n  | 'Throughput'\n  | 'Currency'\n  | 'Temperature'\n  | 'Date';\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":[],"mappings":"AAAA,+BAA+B;AAC/B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAsEjC,WAGC"}

package/dist/model/units.d.ts

@@ -0,0 +1,105 @@
+import { BytesFormatOptions as BytesFormatOptions } from './bytes';
+import { BitsFormatOptions as BitsFormatOptions } from './bits';
+import { DecimalFormatOptions as DecimalFormatOptions } from './decimal';
+import { PercentFormatOptions as PercentFormatOptions } from './percent';
+import { TemperatureFormatOptions } from './temperature';
+import { TimeFormatOptions as TimeFormatOptions } from './time';
+import { UnitGroup, UnitGroupConfig, UnitConfig } from './types';
+import { ThroughputFormatOptions } from './throughput';
+import { CurrencyFormatOptions } from './currency';
+import { DateFormatOptions } from './date';
+/**
+ * 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 "datetime-local": UnitConfig;
+    readonly "datetime-iso": UnitConfig;
+    readonly "datetime-us": UnitConfig;
+    readonly "date-iso": UnitConfig;
+    readonly "date-us": UnitConfig;
+    readonly "date-local": UnitConfig;
+    readonly "time-local": UnitConfig;
+    readonly "time-iso": UnitConfig;
+    readonly "time-us": UnitConfig;
+    readonly "relative-time": UnitConfig;
+    readonly "unix-timestamp": UnitConfig;
+    readonly "unix-timestamp-ms": UnitConfig;
+    readonly celsius: UnitConfig;
+    readonly fahrenheit: UnitConfig;
+    readonly aud: UnitConfig;
+    readonly cad: UnitConfig;
+    readonly chf: UnitConfig;
+    readonly cny: UnitConfig;
+    readonly eur: UnitConfig;
+    readonly gbp: UnitConfig;
+    readonly hkd: UnitConfig;
+    readonly inr: UnitConfig;
+    readonly jpy: UnitConfig;
+    readonly krw: UnitConfig;
+    readonly nok: UnitConfig;
+    readonly nzd: UnitConfig;
+    readonly sek: UnitConfig;
+    readonly sgd: UnitConfig;
+    readonly usd: UnitConfig;
+    readonly "bits/sec": UnitConfig;
+    readonly "decbits/sec": UnitConfig;
+    readonly "bytes/sec": UnitConfig;
+    readonly "decbytes/sec": 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 bits: UnitConfig;
+    readonly decbits: UnitConfig;
+    readonly bytes: UnitConfig;
+    readonly decbytes: UnitConfig;
+    readonly decimal: UnitConfig;
+    readonly percent: UnitConfig;
+    readonly "percent-decimal": UnitConfig;
+    readonly "%": UnitConfig;
+    readonly years: UnitConfig;
+    readonly months: UnitConfig;
+    readonly weeks: UnitConfig;
+    readonly days: UnitConfig;
+    readonly hours: UnitConfig;
+    readonly minutes: UnitConfig;
+    readonly seconds: UnitConfig;
+    readonly nanoseconds: UnitConfig;
+    readonly microseconds: UnitConfig;
+    readonly milliseconds: UnitConfig;
+};
+export type FormatOptions = TimeFormatOptions | PercentFormatOptions | DecimalFormatOptions | BytesFormatOptions | BitsFormatOptions | ThroughputFormatOptions | CurrencyFormatOptions | TemperatureFormatOptions | DateFormatOptions;
+type HasDecimalPlaces<UnitOpt> = UnitOpt extends {
+    decimalPlaces?: number;
+} ? UnitOpt : never;
+type HasShortValues<UnitOpt> = UnitOpt extends {
+    shortValues?: boolean;
+} ? UnitOpt : never;
+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 isBitsUnit(formatOptions: FormatOptions): formatOptions is BitsFormatOptions;
+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 declare function isCurrencyUnit(formatOptions: FormatOptions): formatOptions is CurrencyFormatOptions;
+export declare function isDateUnit(formatOptions: FormatOptions): formatOptions is DateFormatOptions;
+export declare function isTemperatureUnit(formatOptions: FormatOptions): formatOptions is TemperatureFormatOptions;
+export {};
+//# sourceMappingURL=units.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../src/model/units.ts"],"names":[],"mappings":"AAaA,OAAO,EAAe,kBAAkB,IAAI,kBAAkB,EAAyC,MAAM,SAAS,CAAC;AACvH,OAAO,EAAc,iBAAiB,IAAI,iBAAiB,EAAuC,MAAM,QAAQ,CAAC;AACjH,OAAO,EAEL,oBAAoB,IAAI,oBAAoB,EAG7C,MAAM,WAAW,CAAC;AACnB,OAAO,EAEL,oBAAoB,IAAI,oBAAoB,EAG7C,MAAM,WAAW,CAAC;AACnB,OAAO,EAIL,wBAAwB,EACzB,MAAM,eAAe,CAAC;AACvB,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;AACtB,OAAO,EAA+D,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAChH,OAAO,EAAc,iBAAiB,EAAuC,MAAM,QAAQ,CAAC;AAE5F;;;;;;GAMG;AAEH,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,CAU1E,CAAC;AACF,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAUd,CAAC;AAEX,MAAM,MAAM,aAAa,GACrB,iBAAiB,GACjB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,iBAAiB,GACjB,uBAAuB,GACvB,qBAAqB,GACrB,wBAAwB,GACxB,iBAAiB,CAAC;AAEtB,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,CA2ChF;AAED,wBAAgB,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,UAAU,CAGtE;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,UAAU,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,IAAI,iBAAiB,CAE3F;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;AAED,wBAAgB,cAAc,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,IAAI,qBAAqB,CAEnG;AAED,wBAAgB,UAAU,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,IAAI,iBAAiB,CAE3F;AAED,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,IAAI,wBAAwB,CAEzG"}

package/dist/model/units.js

@@ -0,0 +1,132 @@
+// Copyright 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 { formatBytes, BYTES_GROUP_CONFIG, BYTES_UNIT_CONFIG } from './bytes';
+import { formatBits, BITS_GROUP_CONFIG, BITS_UNIT_CONFIG } from './bits';
+import { formatDecimal, DECIMAL_GROUP_CONFIG, DECIMAL_UNIT_CONFIG } from './decimal';
+import { formatPercent, PERCENT_GROUP_CONFIG, PERCENT_UNIT_CONFIG } from './percent';
+import { TEMPERATURE_GROUP_CONFIG, formatTemperature, TEMPERATURE_UNIT_CONFIG } from './temperature';
+import { formatTime, TIME_GROUP_CONFIG, TIME_UNIT_CONFIG } from './time';
+import { formatThroughput, THROUGHPUT_GROUP_CONFIG, THROUGHPUT_UNIT_CONFIG } from './throughput';
+import { formatCurrency, CURRENCY_GROUP_CONFIG, CURRENCY_UNIT_CONFIG } from './currency';
+import { formatDate, DATE_GROUP_CONFIG, DATE_UNIT_CONFIG } from './date';
+/**
+ * Most of the number formatting is based on Intl.NumberFormat, which is built into JavaScript.
+ * Prefer Intl.NumbeFormat because it covers most use cases and will continue to be supported with time.
+ *
+ * To format bytes, we also make use of the `numbro` package,
+ * because it can handle adding units like KB, MB, GB, etc. correctly.
+ */ export const UNIT_GROUP_CONFIG = {
+    Time: TIME_GROUP_CONFIG,
+    Percent: PERCENT_GROUP_CONFIG,
+    Decimal: DECIMAL_GROUP_CONFIG,
+    Bytes: BYTES_GROUP_CONFIG,
+    Bits: BITS_GROUP_CONFIG,
+    Throughput: THROUGHPUT_GROUP_CONFIG,
+    Currency: CURRENCY_GROUP_CONFIG,
+    Temperature: TEMPERATURE_GROUP_CONFIG,
+    Date: DATE_GROUP_CONFIG
+};
+export const UNIT_CONFIG = {
+    ...TIME_UNIT_CONFIG,
+    ...PERCENT_UNIT_CONFIG,
+    ...DECIMAL_UNIT_CONFIG,
+    ...BYTES_UNIT_CONFIG,
+    ...BITS_UNIT_CONFIG,
+    ...THROUGHPUT_UNIT_CONFIG,
+    ...CURRENCY_UNIT_CONFIG,
+    ...TEMPERATURE_UNIT_CONFIG,
+    ...DATE_UNIT_CONFIG
+};
+export function formatValue(value, formatOptions) {
+    if (!formatOptions) {
+        return value.toString();
+    }
+    if (isBytesUnit(formatOptions)) {
+        return formatBytes(value, formatOptions);
+    }
+    if (isBitsUnit(formatOptions)) {
+        return formatBits(value, formatOptions);
+    }
+    if (isDecimalUnit(formatOptions)) {
+        return formatDecimal(value, formatOptions);
+    }
+    if (isPercentUnit(formatOptions)) {
+        return formatPercent(value, formatOptions);
+    }
+    if (isTimeUnit(formatOptions)) {
+        return formatTime(value, formatOptions);
+    }
+    if (isThroughputUnit(formatOptions)) {
+        return formatThroughput(value, formatOptions);
+    }
+    if (isCurrencyUnit(formatOptions)) {
+        return formatCurrency(value, formatOptions);
+    }
+    if (isDateUnit(formatOptions)) {
+        return formatDate(value, formatOptions);
+    }
+    if (isTemperatureUnit(formatOptions)) {
+        return formatTemperature(value, formatOptions);
+    }
+    const exhaustive = formatOptions;
+    throw new Error(`Unknown unit options ${exhaustive}`);
+}
+export function getUnitConfig(formatOptions) {
+    const unit = formatOptions.unit ?? 'decimal';
+    return UNIT_CONFIG[unit];
+}
+export function getUnitGroup(formatOptions) {
+    return getUnitConfig(formatOptions).group ?? 'Decimal';
+}
+export function getUnitGroupConfig(formatOptions) {
+    const unitConfig = getUnitConfig(formatOptions);
+    return UNIT_GROUP_CONFIG[unitConfig.group ?? 'Decimal'];
+}
+// Type guards
+export function isTimeUnit(formatOptions) {
+    return getUnitGroup(formatOptions) === 'Time';
+}
+export function isPercentUnit(formatOptions) {
+    return getUnitGroup(formatOptions) === 'Percent';
+}
+export function isDecimalUnit(formatOptions) {
+    return getUnitGroup(formatOptions) === 'Decimal';
+}
+export function isBytesUnit(formatOptions) {
+    return getUnitGroup(formatOptions) === 'Bytes';
+}
+export function isBitsUnit(formatOptions) {
+    return getUnitGroup(formatOptions) === 'Bits';
+}
+export function isUnitWithDecimalPlaces(formatOptions) {
+    const groupConfig = getUnitGroupConfig(formatOptions);
+    return !!groupConfig.decimalPlaces;
+}
+export function isUnitWithShortValues(formatOptions) {
+    const groupConfig = getUnitGroupConfig(formatOptions);
+    return !!groupConfig.shortValues;
+}
+export function isThroughputUnit(formatOptions) {
+    return getUnitGroup(formatOptions) === 'Throughput';
+}
+export function isCurrencyUnit(formatOptions) {
+    return getUnitGroup(formatOptions) === 'Currency';
+}
+export function isDateUnit(formatOptions) {
+    return getUnitGroup(formatOptions) === 'Date';
+}
+export function isTemperatureUnit(formatOptions) {
+    return getUnitGroup(formatOptions) === 'Temperature';
+}
+
+//# sourceMappingURL=units.js.map

package/dist/model/units.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/model/units.ts"],"sourcesContent":["// Copyright The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { formatBytes, BytesFormatOptions as BytesFormatOptions, BYTES_GROUP_CONFIG, BYTES_UNIT_CONFIG } from './bytes';\nimport { formatBits, BitsFormatOptions as BitsFormatOptions, BITS_GROUP_CONFIG, BITS_UNIT_CONFIG } from './bits';\nimport {\n  formatDecimal,\n  DecimalFormatOptions as DecimalFormatOptions,\n  DECIMAL_GROUP_CONFIG,\n  DECIMAL_UNIT_CONFIG,\n} from './decimal';\nimport {\n  formatPercent,\n  PercentFormatOptions as PercentFormatOptions,\n  PERCENT_GROUP_CONFIG,\n  PERCENT_UNIT_CONFIG,\n} from './percent';\nimport {\n  TEMPERATURE_GROUP_CONFIG,\n  formatTemperature,\n  TEMPERATURE_UNIT_CONFIG,\n  TemperatureFormatOptions,\n} from './temperature';\nimport { formatTime, TimeFormatOptions as TimeFormatOptions, TIME_GROUP_CONFIG, TIME_UNIT_CONFIG } from './time';\nimport { UnitGroup, UnitGroupConfig, UnitConfig } from './types';\nimport {\n  formatThroughput,\n  THROUGHPUT_GROUP_CONFIG,\n  THROUGHPUT_UNIT_CONFIG,\n  ThroughputFormatOptions,\n} from './throughput';\nimport { formatCurrency, CURRENCY_GROUP_CONFIG, CURRENCY_UNIT_CONFIG, CurrencyFormatOptions } from './currency';\nimport { formatDate, DateFormatOptions, DATE_GROUP_CONFIG, DATE_UNIT_CONFIG } from './date';\n\n/**\n * Most of the number formatting is based on Intl.NumberFormat, which is built into JavaScript.\n * Prefer Intl.NumbeFormat because it covers most use cases and will continue to be supported with time.\n *\n * To format bytes, we also make use of the `numbro` package,\n * because it can handle adding units like KB, MB, GB, etc. correctly.\n */\n\nexport const UNIT_GROUP_CONFIG: Readonly<Record<UnitGroup, UnitGroupConfig>> = {\n  Time: TIME_GROUP_CONFIG,\n  Percent: PERCENT_GROUP_CONFIG,\n  Decimal: DECIMAL_GROUP_CONFIG,\n  Bytes: BYTES_GROUP_CONFIG,\n  Bits: BITS_GROUP_CONFIG,\n  Throughput: THROUGHPUT_GROUP_CONFIG,\n  Currency: CURRENCY_GROUP_CONFIG,\n  Temperature: TEMPERATURE_GROUP_CONFIG,\n  Date: DATE_GROUP_CONFIG,\n};\nexport const UNIT_CONFIG = {\n  ...TIME_UNIT_CONFIG,\n  ...PERCENT_UNIT_CONFIG,\n  ...DECIMAL_UNIT_CONFIG,\n  ...BYTES_UNIT_CONFIG,\n  ...BITS_UNIT_CONFIG,\n  ...THROUGHPUT_UNIT_CONFIG,\n  ...CURRENCY_UNIT_CONFIG,\n  ...TEMPERATURE_UNIT_CONFIG,\n  ...DATE_UNIT_CONFIG,\n} as const;\n\nexport type FormatOptions =\n  | TimeFormatOptions\n  | PercentFormatOptions\n  | DecimalFormatOptions\n  | BytesFormatOptions\n  | BitsFormatOptions\n  | ThroughputFormatOptions\n  | CurrencyFormatOptions\n  | TemperatureFormatOptions\n  | DateFormatOptions;\n\ntype HasDecimalPlaces<UnitOpt> = UnitOpt extends { decimalPlaces?: number } ? UnitOpt : never;\ntype HasShortValues<UnitOpt> = UnitOpt extends { shortValues?: boolean } ? UnitOpt : never;\n\nexport function formatValue(value: number, formatOptions?: FormatOptions): string {\n  if (!formatOptions) {\n    return value.toString();\n  }\n\n  if (isBytesUnit(formatOptions)) {\n    return formatBytes(value, formatOptions);\n  }\n\n  if (isBitsUnit(formatOptions)) {\n    return formatBits(value, formatOptions);\n  }\n\n  if (isDecimalUnit(formatOptions)) {\n    return formatDecimal(value, formatOptions);\n  }\n\n  if (isPercentUnit(formatOptions)) {\n    return formatPercent(value, formatOptions);\n  }\n\n  if (isTimeUnit(formatOptions)) {\n    return formatTime(value, formatOptions);\n  }\n\n  if (isThroughputUnit(formatOptions)) {\n    return formatThroughput(value, formatOptions);\n  }\n\n  if (isCurrencyUnit(formatOptions)) {\n    return formatCurrency(value, formatOptions);\n  }\n\n  if (isDateUnit(formatOptions)) {\n    return formatDate(value, formatOptions);\n  }\n\n  if (isTemperatureUnit(formatOptions)) {\n    return formatTemperature(value, formatOptions);\n  }\n\n  const exhaustive: never = formatOptions;\n  throw new Error(`Unknown unit options ${exhaustive}`);\n}\n\nexport function getUnitConfig(formatOptions: FormatOptions): UnitConfig {\n  const unit = formatOptions.unit ?? 'decimal';\n  return UNIT_CONFIG[unit];\n}\n\nexport function getUnitGroup(formatOptions: FormatOptions): UnitGroup {\n  return getUnitConfig(formatOptions).group ?? 'Decimal';\n}\n\nexport function getUnitGroupConfig(formatOptions: FormatOptions): UnitGroupConfig {\n  const unitConfig = getUnitConfig(formatOptions);\n  return UNIT_GROUP_CONFIG[unitConfig.group ?? 'Decimal'];\n}\n\n// Type guards\nexport function isTimeUnit(formatOptions: FormatOptions): formatOptions is TimeFormatOptions {\n  return getUnitGroup(formatOptions) === 'Time';\n}\n\nexport function isPercentUnit(formatOptions: FormatOptions): formatOptions is PercentFormatOptions {\n  return getUnitGroup(formatOptions) === 'Percent';\n}\n\nexport function isDecimalUnit(formatOptions: FormatOptions): formatOptions is DecimalFormatOptions {\n  return getUnitGroup(formatOptions) === 'Decimal';\n}\n\nexport function isBytesUnit(formatOptions: FormatOptions): formatOptions is BytesFormatOptions {\n  return getUnitGroup(formatOptions) === 'Bytes';\n}\n\nexport function isBitsUnit(formatOptions: FormatOptions): formatOptions is BitsFormatOptions {\n  return getUnitGroup(formatOptions) === 'Bits';\n}\n\nexport function isUnitWithDecimalPlaces(\n  formatOptions: FormatOptions\n): formatOptions is HasDecimalPlaces<FormatOptions> {\n  const groupConfig = getUnitGroupConfig(formatOptions);\n\n  return !!groupConfig.decimalPlaces;\n}\n\nexport function isUnitWithShortValues(formatOptions: FormatOptions): formatOptions is HasShortValues<FormatOptions> {\n  const groupConfig = getUnitGroupConfig(formatOptions);\n\n  return !!groupConfig.shortValues;\n}\n\nexport function isThroughputUnit(formatOptions: FormatOptions): formatOptions is ThroughputFormatOptions {\n  return getUnitGroup(formatOptions) === 'Throughput';\n}\n\nexport function isCurrencyUnit(formatOptions: FormatOptions): formatOptions is CurrencyFormatOptions {\n  return getUnitGroup(formatOptions) === 'Currency';\n}\n\nexport function isDateUnit(formatOptions: FormatOptions): formatOptions is DateFormatOptions {\n  return getUnitGroup(formatOptions) === 'Date';\n}\n\nexport function isTemperatureUnit(formatOptions: FormatOptions): formatOptions is TemperatureFormatOptions {\n  return getUnitGroup(formatOptions) === 'Temperature';\n}\n"],"names":["formatBytes","BYTES_GROUP_CONFIG","BYTES_UNIT_CONFIG","formatBits","BITS_GROUP_CONFIG","BITS_UNIT_CONFIG","formatDecimal","DECIMAL_GROUP_CONFIG","DECIMAL_UNIT_CONFIG","formatPercent","PERCENT_GROUP_CONFIG","PERCENT_UNIT_CONFIG","TEMPERATURE_GROUP_CONFIG","formatTemperature","TEMPERATURE_UNIT_CONFIG","formatTime","TIME_GROUP_CONFIG","TIME_UNIT_CONFIG","formatThroughput","THROUGHPUT_GROUP_CONFIG","THROUGHPUT_UNIT_CONFIG","formatCurrency","CURRENCY_GROUP_CONFIG","CURRENCY_UNIT_CONFIG","formatDate","DATE_GROUP_CONFIG","DATE_UNIT_CONFIG","UNIT_GROUP_CONFIG","Time","Percent","Decimal","Bytes","Bits","Throughput","Currency","Temperature","Date","UNIT_CONFIG","formatValue","value","formatOptions","toString","isBytesUnit","isBitsUnit","isDecimalUnit","isPercentUnit","isTimeUnit","isThroughputUnit","isCurrencyUnit","isDateUnit","isTemperatureUnit","exhaustive","Error","getUnitConfig","unit","getUnitGroup","group","getUnitGroupConfig","unitConfig","isUnitWithDecimalPlaces","groupConfig","decimalPlaces","isUnitWithShortValues","shortValues"],"mappings":"AAAA,+BAA+B;AAC/B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SAASA,WAAW,EAA4CC,kBAAkB,EAAEC,iBAAiB,QAAQ,UAAU;AACvH,SAASC,UAAU,EAA0CC,iBAAiB,EAAEC,gBAAgB,QAAQ,SAAS;AACjH,SACEC,aAAa,EAEbC,oBAAoB,EACpBC,mBAAmB,QACd,YAAY;AACnB,SACEC,aAAa,EAEbC,oBAAoB,EACpBC,mBAAmB,QACd,YAAY;AACnB,SACEC,wBAAwB,EACxBC,iBAAiB,EACjBC,uBAAuB,QAElB,gBAAgB;AACvB,SAASC,UAAU,EAA0CC,iBAAiB,EAAEC,gBAAgB,QAAQ,SAAS;AAEjH,SACEC,gBAAgB,EAChBC,uBAAuB,EACvBC,sBAAsB,QAEjB,eAAe;AACtB,SAASC,cAAc,EAAEC,qBAAqB,EAAEC,oBAAoB,QAA+B,aAAa;AAChH,SAASC,UAAU,EAAqBC,iBAAiB,EAAEC,gBAAgB,QAAQ,SAAS;AAE5F;;;;;;CAMC,GAED,OAAO,MAAMC,oBAAkE;IAC7EC,MAAMZ;IACNa,SAASnB;IACToB,SAASvB;IACTwB,OAAO9B;IACP+B,MAAM5B;IACN6B,YAAYd;IACZe,UAAUZ;IACVa,aAAavB;IACbwB,MAAMX;AACR,EAAE;AACF,OAAO,MAAMY,cAAc;IACzB,GAAGpB,gBAAgB;IACnB,GAAGN,mBAAmB;IACtB,GAAGH,mBAAmB;IACtB,GAAGN,iBAAiB;IACpB,GAAGG,gBAAgB;IACnB,GAAGe,sBAAsB;IACzB,GAAGG,oBAAoB;IACvB,GAAGT,uBAAuB;IAC1B,GAAGY,gBAAgB;AACrB,EAAW;AAgBX,OAAO,SAASY,YAAYC,KAAa,EAAEC,aAA6B;IACtE,IAAI,CAACA,eAAe;QAClB,OAAOD,MAAME,QAAQ;IACvB;IAEA,IAAIC,YAAYF,gBAAgB;QAC9B,OAAOxC,YAAYuC,OAAOC;IAC5B;IAEA,IAAIG,WAAWH,gBAAgB;QAC7B,OAAOrC,WAAWoC,OAAOC;IAC3B;IAEA,IAAII,cAAcJ,gBAAgB;QAChC,OAAOlC,cAAciC,OAAOC;IAC9B;IAEA,IAAIK,cAAcL,gBAAgB;QAChC,OAAO/B,cAAc8B,OAAOC;IAC9B;IAEA,IAAIM,WAAWN,gBAAgB;QAC7B,OAAOzB,WAAWwB,OAAOC;IAC3B;IAEA,IAAIO,iBAAiBP,gBAAgB;QACnC,OAAOtB,iBAAiBqB,OAAOC;IACjC;IAEA,IAAIQ,eAAeR,gBAAgB;QACjC,OAAOnB,eAAekB,OAAOC;IAC/B;IAEA,IAAIS,WAAWT,gBAAgB;QAC7B,OAAOhB,WAAWe,OAAOC;IAC3B;IAEA,IAAIU,kBAAkBV,gBAAgB;QACpC,OAAO3B,kBAAkB0B,OAAOC;IAClC;IAEA,MAAMW,aAAoBX;IAC1B,MAAM,IAAIY,MAAM,CAAC,qBAAqB,EAAED,YAAY;AACtD;AAEA,OAAO,SAASE,cAAcb,aAA4B;IACxD,MAAMc,OAAOd,cAAcc,IAAI,IAAI;IACnC,OAAOjB,WAAW,CAACiB,KAAK;AAC1B;AAEA,OAAO,SAASC,aAAaf,aAA4B;IACvD,OAAOa,cAAcb,eAAegB,KAAK,IAAI;AAC/C;AAEA,OAAO,SAASC,mBAAmBjB,aAA4B;IAC7D,MAAMkB,aAAaL,cAAcb;IACjC,OAAOb,iBAAiB,CAAC+B,WAAWF,KAAK,IAAI,UAAU;AACzD;AAEA,cAAc;AACd,OAAO,SAASV,WAAWN,aAA4B;IACrD,OAAOe,aAAaf,mBAAmB;AACzC;AAEA,OAAO,SAASK,cAAcL,aAA4B;IACxD,OAAOe,aAAaf,mBAAmB;AACzC;AAEA,OAAO,SAASI,cAAcJ,aAA4B;IACxD,OAAOe,aAAaf,mBAAmB;AACzC;AAEA,OAAO,SAASE,YAAYF,aAA4B;IACtD,OAAOe,aAAaf,mBAAmB;AACzC;AAEA,OAAO,SAASG,WAAWH,aAA4B;IACrD,OAAOe,aAAaf,mBAAmB;AACzC;AAEA,OAAO,SAASmB,wBACdnB,aAA4B;IAE5B,MAAMoB,cAAcH,mBAAmBjB;IAEvC,OAAO,CAAC,CAACoB,YAAYC,aAAa;AACpC;AAEA,OAAO,SAASC,sBAAsBtB,aAA4B;IAChE,MAAMoB,cAAcH,mBAAmBjB;IAEvC,OAAO,CAAC,CAACoB,YAAYG,WAAW;AAClC;AAEA,OAAO,SAAShB,iBAAiBP,aAA4B;IAC3D,OAAOe,aAAaf,mBAAmB;AACzC;AAEA,OAAO,SAASQ,eAAeR,aAA4B;IACzD,OAAOe,aAAaf,mBAAmB;AACzC;AAEA,OAAO,SAASS,WAAWT,aAA4B;IACrD,OAAOe,aAAaf,mBAAmB;AACzC;AAEA,OAAO,SAASU,kBAAkBV,aAA4B;IAC5D,OAAOe,aAAaf,mBAAmB;AACzC"}

package/dist/model/utils.d.ts

@@ -0,0 +1,4 @@
+export declare function shouldShortenValues(shortValues?: boolean): boolean;
+export declare function hasDecimalPlaces(decimalPlaces?: number): boolean;
+export declare function limitDecimalPlaces(num?: number): number | undefined;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/model/utils.ts"],"names":[],"mappings":"AAaA,wBAAgB,mBAAmB,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAElE;AAED,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAEhE;AAKD,wBAAgB,kBAAkB,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAUnE"}