@perses-dev/core 0.34.0 → 0.35.0

package/dist/cjs/model/calculations.js

@@ -23,67 +23,146 @@ function _export(target, all) {
 _export(exports, {
     CalculationsMap: ()=>CalculationsMap,
     CALCULATIONS_CONFIG: ()=>CALCULATIONS_CONFIG,
-    DEFAULT_CALCULATION: ()=>DEFAULT_CALCULATION
+    DEFAULT_CALCULATION: ()=>DEFAULT_CALCULATION,
+    getCalculations: ()=>getCalculations,
+    getCalculation: ()=>getCalculation
 });
-const _findLast = /*#__PURE__*/ _interopRequireDefault(require("lodash/findLast"));
-const _meanBy = /*#__PURE__*/ _interopRequireDefault(require("lodash/meanBy"));
-const _sumBy = /*#__PURE__*/ _interopRequireDefault(require("lodash/sumBy"));
-function _interopRequireDefault(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
 const CalculationsMap = {
     First: first,
     Last: last,
+    FirstNumber: firstNumber,
     LastNumber: lastNumber,
     Mean: mean,
-    Sum: sum
+    Sum: sum,
+    Min: min,
+    Max: max
 };
 const CALCULATIONS_CONFIG = {
     First: {
-        label: 'First'
+        label: 'First',
+        description: 'First value'
     },
     Last: {
-        label: 'Last'
+        label: 'Last',
+        description: 'Last value'
+    },
+    FirstNumber: {
+        label: 'First *',
+        description: 'First numeric value'
     },
     LastNumber: {
-        label: 'Last number'
+        label: 'Last *',
+        description: 'Last numeric value'
     },
     Mean: {
-        label: 'Mean'
+        label: 'Average',
+        description: 'Average value excluding nulls'
     },
     Sum: {
-        label: 'Sum'
+        label: 'Sum',
+        description: 'The sum of all values'
+    },
+    Min: {
+        label: 'Min',
+        description: 'Minimum value'
+    },
+    Max: {
+        label: 'Max',
+        description: 'Maximum value'
     }
 };
 const DEFAULT_CALCULATION = 'Sum';
+function getCalculations(values, includeCalculations) {
+    const calculations = includeCalculations.reduce((initResult, calculation)=>{
+        initResult[calculation] = undefined;
+        return initResult;
+    }, {});
+    // We save these values as separate values instead of directly setting them
+    // in the calculations because they are needed by multiple calculations.
+    let nonNullCount = 0;
+    let sum = 0;
+    // We use this large function capable of performing one or more calculations
+    // in a single iteration of the data to minimize the performance impact of
+    // generating multiple calculations for large timeseries values. This is
+    // less optimized for certain single calculations when done in isolation (e.g.
+    // `Last`), but will be more performant in the more expensive cases where
+    // multiple values are being used (e.g. table legend).
+    values.forEach((tuple, i)=>{
+        const value = tuple[1];
+        if (i === 0 && 'First' in calculations) {
+            calculations.First = value;
+        }
+        if (i === values.length - 1 && 'Last' in calculations) {
+            calculations.Last = value;
+        }
+        // Handling specific to non-null values.
+        if (typeof value === 'number') {
+            nonNullCount += 1;
+            sum += value;
+            if ('FirstNumber' in calculations && calculations.FirstNumber === undefined) {
+                // Save the first number we see.
+                calculations.FirstNumber = value;
+            }
+            if ('LastNumber' in calculations) {
+                // Keep setting the numbers we see, which will eventually be set to the
+                // last number when finished iterating.
+                calculations.LastNumber = value;
+            }
+            if ('Min' in calculations) {
+                if (typeof calculations.Min !== 'number') {
+                    // Init the first time we see a number
+                    calculations.Min = value;
+                } else {
+                    // Use lowest value once initialized
+                    calculations.Min = Math.min(calculations.Min, value);
+                }
+            }
+            if ('Max' in calculations) {
+                if (typeof calculations.Max !== 'number') {
+                    // Init the first time we see a number
+                    calculations.Max = value;
+                } else {
+                    // Use highest value once initialized
+                    calculations.Max = Math.max(calculations.Max, value);
+                }
+            }
+        }
+    });
+    // Set calculations that require iterating over all values.
+    if (nonNullCount > 0 && 'Sum' in calculations) {
+        calculations.Sum = sum;
+    }
+    if (nonNullCount > 0 && 'Mean' in calculations) {
+        calculations.Mean = sum / nonNullCount;
+    }
+    return calculations;
+}
+function getCalculation(values, calculation) {
+    return getCalculations(values, [
+        calculation
+    ])[calculation];
+}
 function first(values) {
-    const tuple = values[0];
-    return tuple === undefined ? undefined : getValue(tuple);
+    return getCalculation(values, 'First');
 }
 function last(values) {
-    if (values.length <= 0) return undefined;
-    const tuple = values[values.length - 1];
-    return tuple === undefined ? undefined : getValue(tuple);
+    return getCalculation(values, 'Last');
+}
+function firstNumber(values) {
+    return getCalculation(values, 'FirstNumber');
 }
 function lastNumber(values) {
-    const tuple = (0, _findLast.default)(values, (tuple)=>isNaN(getValue(tuple)) === false);
-    return tuple === undefined ? undefined : getValue(tuple);
+    return getCalculation(values, 'LastNumber');
 }
 function mean(values) {
-    if (values.length <= 0) return undefined;
-    return (0, _meanBy.default)(values, getValue);
+    return getCalculation(values, 'Mean');
 }
 function sum(values) {
-    if (values.length <= 0) return undefined;
-    return (0, _sumBy.default)(values, getValue);
+    return getCalculation(values, 'Sum');
 }
-function getValue(valueTuple) {
-    const value = valueTuple[1];
-    if (value !== null) {
-        return value;
-    }
-    // TODO: refactor utils so null can be returned and LastNotNull supported
-    return NaN;
+function min(values) {
+    return getCalculation(values, 'Min');
+}
+function max(values) {
+    return getCalculation(values, 'Max');
 }

package/dist/model/calculations.d.ts

@@ -2,20 +2,44 @@ import { TimeSeriesValueTuple } from '@perses-dev/core';
 export declare const CalculationsMap: {
     First: typeof first;
     Last: typeof last;
+    FirstNumber: typeof firstNumber;
     LastNumber: typeof lastNumber;
     Mean: typeof mean;
     Sum: typeof sum;
+    Min: typeof min;
+    Max: typeof max;
 };
 export declare type CalculationType = keyof typeof CalculationsMap;
 export declare type CalculationConfig = {
     label: string;
+    description: string;
 };
 export declare const CALCULATIONS_CONFIG: Readonly<Record<CalculationType, CalculationConfig>>;
 export declare const DEFAULT_CALCULATION: CalculationType;
-declare function first(values: TimeSeriesValueTuple[]): number | undefined;
-declare function last(values: TimeSeriesValueTuple[]): number | undefined;
-declare function lastNumber(values: TimeSeriesValueTuple[]): number | undefined;
-declare function mean(values: TimeSeriesValueTuple[]): number | undefined;
-declare function sum(values: TimeSeriesValueTuple[]): number | undefined;
+declare type CalculationValue = number | null | undefined;
+/**
+ * Calculate a multiple values for a set of time series data.
+ *
+ * @param values - Array of time series data.
+ * @param includeCalculations - Array of calculations to include.
+ */
+export declare function getCalculations<IncludeCalcs extends CalculationType[]>(values: TimeSeriesValueTuple[], includeCalculations: IncludeCalcs): Record<Extract<CalculationType, IncludeCalcs[number]>, CalculationValue>;
+/**
+ * Calculate a single value for a set of time series data.
+ *
+ * Use `getCalculations` instead if you need multiple calculations.
+ *
+ * @param values - Array of time series data.
+ * @param calculation - Name of the calculation to calculate.
+ */
+export declare function getCalculation(values: TimeSeriesValueTuple[], calculation: CalculationType): CalculationValue;
+declare function first(values: TimeSeriesValueTuple[]): CalculationValue;
+declare function last(values: TimeSeriesValueTuple[]): CalculationValue;
+declare function firstNumber(values: TimeSeriesValueTuple[]): CalculationValue;
+declare function lastNumber(values: TimeSeriesValueTuple[]): CalculationValue;
+declare function mean(values: TimeSeriesValueTuple[]): CalculationValue;
+declare function sum(values: TimeSeriesValueTuple[]): CalculationValue;
+declare function min(values: TimeSeriesValueTuple[]): CalculationValue;
+declare function max(values: TimeSeriesValueTuple[]): CalculationValue;
 export {};
 //# sourceMappingURL=calculations.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"calculations.d.ts","sourceRoot":"","sources":["../../src/model/calculations.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAGxD,eAAO,MAAM,eAAe;;;;;;CAM3B,CAAC;AAEF,oBAAY,eAAe,GAAG,MAAM,OAAO,eAAe,CAAC;AAE3D,oBAAY,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AACF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAgB3E,CAAC;AAEX,eAAO,MAAM,mBAAmB,EAAE,eAAuB,CAAC;AAE1D,iBAAS,KAAK,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAGjE;AAED,iBAAS,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAKhE;AAED,iBAAS,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAGtE;AAED,iBAAS,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAGhE;AAED,iBAAS,GAAG,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,GAAG,SAAS,CAG/D"}
+{"version":3,"file":"calculations.d.ts","sourceRoot":"","sources":["../../src/model/calculations.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD,eAAO,MAAM,eAAe;;;;;;;;;CAS3B,CAAC;AAEF,oBAAY,eAAe,GAAG,MAAM,OAAO,eAAe,CAAC;AAE3D,oBAAY,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAiC3E,CAAC;AAEX,eAAO,MAAM,mBAAmB,EAAE,eAAuB,CAAC;AAE1D,aAAK,gBAAgB,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;AAElD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,YAAY,SAAS,eAAe,EAAE,EACpE,MAAM,EAAE,oBAAoB,EAAE,EAC9B,mBAAmB,EAAE,YAAY,GAChC,MAAM,CAGP,OAAO,CAAC,eAAe,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,EAC9C,gBAAgB,CACjB,CA2EA;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,oBAAoB,EAAE,EAAE,WAAW,EAAE,eAAe,oBAE1F;AAED,iBAAS,KAAK,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,gBAAgB,CAE/D;AAED,iBAAS,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,gBAAgB,CAE9D;AAED,iBAAS,WAAW,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,gBAAgB,CAErE;AAED,iBAAS,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,gBAAgB,CAEpE;AAED,iBAAS,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,gBAAgB,CAE9D;AAED,iBAAS,GAAG,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,gBAAgB,CAE7D;AAED,iBAAS,GAAG,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,gBAAgB,CAE7D;AAED,iBAAS,GAAG,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,gBAAgB,CAE7D"}

package/dist/model/calculations.js

@@ -10,63 +10,156 @@
 // 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 findLast from 'lodash/findLast';
-import meanBy from 'lodash/meanBy';
-import sumBy from 'lodash/sumBy';
-// TODO: move this file and calculations.test.ts to @perses-dev/core
 export const CalculationsMap = {
     First: first,
     Last: last,
+    FirstNumber: firstNumber,
     LastNumber: lastNumber,
     Mean: mean,
-    Sum: sum
+    Sum: sum,
+    Min: min,
+    Max: max
 };
 export const CALCULATIONS_CONFIG = {
     First: {
-        label: 'First'
+        label: 'First',
+        description: 'First value'
     },
     Last: {
-        label: 'Last'
+        label: 'Last',
+        description: 'Last value'
+    },
+    FirstNumber: {
+        label: 'First *',
+        description: 'First numeric value'
     },
     LastNumber: {
-        label: 'Last number'
+        label: 'Last *',
+        description: 'Last numeric value'
     },
     Mean: {
-        label: 'Mean'
+        label: 'Average',
+        description: 'Average value excluding nulls'
     },
     Sum: {
-        label: 'Sum'
+        label: 'Sum',
+        description: 'The sum of all values'
+    },
+    Min: {
+        label: 'Min',
+        description: 'Minimum value'
+    },
+    Max: {
+        label: 'Max',
+        description: 'Maximum value'
     }
 };
 export const DEFAULT_CALCULATION = 'Sum';
+/**
+ * Calculate a multiple values for a set of time series data.
+ *
+ * @param values - Array of time series data.
+ * @param includeCalculations - Array of calculations to include.
+ */ export function getCalculations(values, includeCalculations) {
+    const calculations = includeCalculations.reduce((initResult, calculation)=>{
+        initResult[calculation] = undefined;
+        return initResult;
+    }, {});
+    // We save these values as separate values instead of directly setting them
+    // in the calculations because they are needed by multiple calculations.
+    let nonNullCount = 0;
+    let sum = 0;
+    // We use this large function capable of performing one or more calculations
+    // in a single iteration of the data to minimize the performance impact of
+    // generating multiple calculations for large timeseries values. This is
+    // less optimized for certain single calculations when done in isolation (e.g.
+    // `Last`), but will be more performant in the more expensive cases where
+    // multiple values are being used (e.g. table legend).
+    values.forEach((tuple, i)=>{
+        const value = tuple[1];
+        if (i === 0 && 'First' in calculations) {
+            calculations.First = value;
+        }
+        if (i === values.length - 1 && 'Last' in calculations) {
+            calculations.Last = value;
+        }
+        // Handling specific to non-null values.
+        if (typeof value === 'number') {
+            nonNullCount += 1;
+            sum += value;
+            if ('FirstNumber' in calculations && calculations.FirstNumber === undefined) {
+                // Save the first number we see.
+                calculations.FirstNumber = value;
+            }
+            if ('LastNumber' in calculations) {
+                // Keep setting the numbers we see, which will eventually be set to the
+                // last number when finished iterating.
+                calculations.LastNumber = value;
+            }
+            if ('Min' in calculations) {
+                if (typeof calculations.Min !== 'number') {
+                    // Init the first time we see a number
+                    calculations.Min = value;
+                } else {
+                    // Use lowest value once initialized
+                    calculations.Min = Math.min(calculations.Min, value);
+                }
+            }
+            if ('Max' in calculations) {
+                if (typeof calculations.Max !== 'number') {
+                    // Init the first time we see a number
+                    calculations.Max = value;
+                } else {
+                    // Use highest value once initialized
+                    calculations.Max = Math.max(calculations.Max, value);
+                }
+            }
+        }
+    });
+    // Set calculations that require iterating over all values.
+    if (nonNullCount > 0 && 'Sum' in calculations) {
+        calculations.Sum = sum;
+    }
+    if (nonNullCount > 0 && 'Mean' in calculations) {
+        calculations.Mean = sum / nonNullCount;
+    }
+    return calculations;
+}
+/**
+ * Calculate a single value for a set of time series data.
+ *
+ * Use `getCalculations` instead if you need multiple calculations.
+ *
+ * @param values - Array of time series data.
+ * @param calculation - Name of the calculation to calculate.
+ */ export function getCalculation(values, calculation) {
+    return getCalculations(values, [
+        calculation
+    ])[calculation];
+}
 function first(values) {
-    const tuple = values[0];
-    return tuple === undefined ? undefined : getValue(tuple);
+    return getCalculation(values, 'First');
 }
 function last(values) {
-    if (values.length <= 0) return undefined;
-    const tuple = values[values.length - 1];
-    return tuple === undefined ? undefined : getValue(tuple);
+    return getCalculation(values, 'Last');
+}
+function firstNumber(values) {
+    return getCalculation(values, 'FirstNumber');
 }
 function lastNumber(values) {
-    const tuple = findLast(values, (tuple)=>isNaN(getValue(tuple)) === false);
-    return tuple === undefined ? undefined : getValue(tuple);
+    return getCalculation(values, 'LastNumber');
 }
 function mean(values) {
-    if (values.length <= 0) return undefined;
-    return meanBy(values, getValue);
+    return getCalculation(values, 'Mean');
 }
 function sum(values) {
-    if (values.length <= 0) return undefined;
-    return sumBy(values, getValue);
+    return getCalculation(values, 'Sum');
 }
-function getValue(valueTuple) {
-    const value = valueTuple[1];
-    if (value !== null) {
-        return value;
-    }
-    // TODO: refactor utils so null can be returned and LastNotNull supported
-    return NaN;
+function min(values) {
+    return getCalculation(values, 'Min');
+}
+function max(values) {
+    return getCalculation(values, 'Max');
 }
 
 //# sourceMappingURL=calculations.js.map

package/dist/model/calculations.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/model/calculations.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 findLast from 'lodash/findLast';\nimport meanBy from 'lodash/meanBy';\nimport sumBy from 'lodash/sumBy';\nimport { TimeSeriesValueTuple } from '@perses-dev/core';\n\n// TODO: move this file and calculations.test.ts to @perses-dev/core\nexport const CalculationsMap = {\n  First: first,\n  Last: last,\n  LastNumber: lastNumber,\n  Mean: mean,\n  Sum: sum,\n};\n\nexport type CalculationType = keyof typeof CalculationsMap;\n\nexport type CalculationConfig = {\n  label: string;\n};\nexport const CALCULATIONS_CONFIG: Readonly<Record<CalculationType, CalculationConfig>> = {\n  First: {\n    label: 'First',\n  },\n  Last: {\n    label: 'Last',\n  },\n  LastNumber: {\n    label: 'Last number',\n  },\n  Mean: {\n    label: 'Mean',\n  },\n  Sum: {\n    label: 'Sum',\n  },\n} as const;\n\nexport const DEFAULT_CALCULATION: CalculationType = 'Sum';\n\nfunction first(values: TimeSeriesValueTuple[]): number | undefined {\n  const tuple = values[0];\n  return tuple === undefined ? undefined : getValue(tuple);\n}\n\nfunction last(values: TimeSeriesValueTuple[]): number | undefined {\n  if (values.length <= 0) return undefined;\n\n  const tuple = values[values.length - 1];\n  return tuple === undefined ? undefined : getValue(tuple);\n}\n\nfunction lastNumber(values: TimeSeriesValueTuple[]): number | undefined {\n  const tuple = findLast(values, (tuple) => isNaN(getValue(tuple)) === false);\n  return tuple === undefined ? undefined : getValue(tuple);\n}\n\nfunction mean(values: TimeSeriesValueTuple[]): number | undefined {\n  if (values.length <= 0) return undefined;\n  return meanBy(values, getValue);\n}\n\nfunction sum(values: TimeSeriesValueTuple[]): number | undefined {\n  if (values.length <= 0) return undefined;\n  return sumBy(values, getValue);\n}\n\nfunction getValue(valueTuple: TimeSeriesValueTuple) {\n  const value = valueTuple[1];\n  if (value !== null) {\n    return value;\n  }\n  // TODO: refactor utils so null can be returned and LastNotNull supported\n  return NaN;\n}\n"],"names":["findLast","meanBy","sumBy","CalculationsMap","First","first","Last","last","LastNumber","lastNumber","Mean","mean","Sum","sum","CALCULATIONS_CONFIG","label","DEFAULT_CALCULATION","values","tuple","undefined","getValue","length","isNaN","valueTuple","value","NaN"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,OAAOA,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAOC,MAAM,MAAM,eAAe,CAAC;AACnC,OAAOC,KAAK,MAAM,cAAc,CAAC;AAGjC,oEAAoE;AACpE,OAAO,MAAMC,eAAe,GAAG;IAC7BC,KAAK,EAAEC,KAAK;IACZC,IAAI,EAAEC,IAAI;IACVC,UAAU,EAAEC,UAAU;IACtBC,IAAI,EAAEC,IAAI;IACVC,GAAG,EAAEC,GAAG;CACT,CAAC;AAOF,OAAO,MAAMC,mBAAmB,GAAyD;IACvFV,KAAK,EAAE;QACLW,KAAK,EAAE,OAAO;KACf;IACDT,IAAI,EAAE;QACJS,KAAK,EAAE,MAAM;KACd;IACDP,UAAU,EAAE;QACVO,KAAK,EAAE,aAAa;KACrB;IACDL,IAAI,EAAE;QACJK,KAAK,EAAE,MAAM;KACd;IACDH,GAAG,EAAE;QACHG,KAAK,EAAE,KAAK;KACb;CACF,AAAS,CAAC;AAEX,OAAO,MAAMC,mBAAmB,GAAoB,KAAK,CAAC;AAE1D,SAASX,KAAK,CAACY,MAA8B,EAAsB;IACjE,MAAMC,KAAK,GAAGD,MAAM,CAAC,CAAC,CAAC,AAAC;IACxB,OAAOC,KAAK,KAAKC,SAAS,GAAGA,SAAS,GAAGC,QAAQ,CAACF,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAASX,IAAI,CAACU,MAA8B,EAAsB;IAChE,IAAIA,MAAM,CAACI,MAAM,IAAI,CAAC,EAAE,OAAOF,SAAS,CAAC;IAEzC,MAAMD,KAAK,GAAGD,MAAM,CAACA,MAAM,CAACI,MAAM,GAAG,CAAC,CAAC,AAAC;IACxC,OAAOH,KAAK,KAAKC,SAAS,GAAGA,SAAS,GAAGC,QAAQ,CAACF,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAAST,UAAU,CAACQ,MAA8B,EAAsB;IACtE,MAAMC,KAAK,GAAGlB,QAAQ,CAACiB,MAAM,EAAE,CAACC,KAAK,GAAKI,KAAK,CAACF,QAAQ,CAACF,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC,AAAC;IAC5E,OAAOA,KAAK,KAAKC,SAAS,GAAGA,SAAS,GAAGC,QAAQ,CAACF,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAASP,IAAI,CAACM,MAA8B,EAAsB;IAChE,IAAIA,MAAM,CAACI,MAAM,IAAI,CAAC,EAAE,OAAOF,SAAS,CAAC;IACzC,OAAOlB,MAAM,CAACgB,MAAM,EAAEG,QAAQ,CAAC,CAAC;AAClC,CAAC;AAED,SAASP,GAAG,CAACI,MAA8B,EAAsB;IAC/D,IAAIA,MAAM,CAACI,MAAM,IAAI,CAAC,EAAE,OAAOF,SAAS,CAAC;IACzC,OAAOjB,KAAK,CAACe,MAAM,EAAEG,QAAQ,CAAC,CAAC;AACjC,CAAC;AAED,SAASA,QAAQ,CAACG,UAAgC,EAAE;IAClD,MAAMC,KAAK,GAAGD,UAAU,CAAC,CAAC,CAAC,AAAC;IAC5B,IAAIC,KAAK,KAAK,IAAI,EAAE;QAClB,OAAOA,KAAK,CAAC;IACf,CAAC;IACD,yEAAyE;IACzE,OAAOC,GAAG,CAAC;AACb,CAAC"}
+{"version":3,"sources":["../../src/model/calculations.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 { TimeSeriesValueTuple } from '@perses-dev/core';\n\nexport const CalculationsMap = {\n  First: first,\n  Last: last,\n  FirstNumber: firstNumber,\n  LastNumber: lastNumber,\n  Mean: mean,\n  Sum: sum,\n  Min: min,\n  Max: max,\n};\n\nexport type CalculationType = keyof typeof CalculationsMap;\n\nexport type CalculationConfig = {\n  label: string;\n  description: string;\n};\n\nexport const CALCULATIONS_CONFIG: Readonly<Record<CalculationType, CalculationConfig>> = {\n  First: {\n    label: 'First',\n    description: 'First value',\n  },\n  Last: {\n    label: 'Last',\n    description: 'Last value',\n  },\n  FirstNumber: {\n    label: 'First *',\n    description: 'First numeric value',\n  },\n  LastNumber: {\n    label: 'Last *',\n    description: 'Last numeric value',\n  },\n  Mean: {\n    label: 'Average',\n    description: 'Average value excluding nulls',\n  },\n  Sum: {\n    label: 'Sum',\n    description: 'The sum of all values',\n  },\n  Min: {\n    label: 'Min',\n    description: 'Minimum value',\n  },\n  Max: {\n    label: 'Max',\n    description: 'Maximum value',\n  },\n} as const;\n\nexport const DEFAULT_CALCULATION: CalculationType = 'Sum';\n\ntype CalculationValue = number | null | undefined;\n\n/**\n * Calculate a multiple values for a set of time series data.\n *\n * @param values - Array of time series data.\n * @param includeCalculations - Array of calculations to include.\n */\nexport function getCalculations<IncludeCalcs extends CalculationType[]>(\n  values: TimeSeriesValueTuple[],\n  includeCalculations: IncludeCalcs\n): Record<\n  // This extract combined with the generics above keeps the key of the returned\n  // record to *just* the specified calculations.\n  Extract<CalculationType, IncludeCalcs[number]>,\n  CalculationValue\n> {\n  const calculations = includeCalculations.reduce((initResult, calculation) => {\n    initResult[calculation] = undefined;\n    return initResult;\n  }, {} as Record<string, CalculationValue>);\n\n  // We save these values as separate values instead of directly setting them\n  // in the calculations because they are needed by multiple calculations.\n  let nonNullCount = 0;\n  let sum = 0;\n\n  // We use this large function capable of performing one or more calculations\n  // in a single iteration of the data to minimize the performance impact of\n  // generating multiple calculations for large timeseries values. This is\n  // less optimized for certain single calculations when done in isolation (e.g.\n  // `Last`), but will be more performant in the more expensive cases where\n  // multiple values are being used (e.g. table legend).\n  values.forEach((tuple, i) => {\n    const value = tuple[1];\n\n    if (i === 0 && 'First' in calculations) {\n      calculations.First = value;\n    }\n    if (i === values.length - 1 && 'Last' in calculations) {\n      calculations.Last = value;\n    }\n\n    // Handling specific to non-null values.\n    if (typeof value === 'number') {\n      nonNullCount += 1;\n      sum += value;\n\n      if ('FirstNumber' in calculations && calculations.FirstNumber === undefined) {\n        // Save the first number we see.\n        calculations.FirstNumber = value;\n      }\n\n      if ('LastNumber' in calculations) {\n        // Keep setting the numbers we see, which will eventually be set to the\n        // last number when finished iterating.\n        calculations.LastNumber = value;\n      }\n\n      if ('Min' in calculations) {\n        if (typeof calculations.Min !== 'number') {\n          // Init the first time we see a number\n          calculations.Min = value;\n        } else {\n          // Use lowest value once initialized\n          calculations.Min = Math.min(calculations.Min, value);\n        }\n      }\n\n      if ('Max' in calculations) {\n        if (typeof calculations.Max !== 'number') {\n          // Init the first time we see a number\n          calculations.Max = value;\n        } else {\n          // Use highest value once initialized\n          calculations.Max = Math.max(calculations.Max, value);\n        }\n      }\n    }\n  });\n\n  // Set calculations that require iterating over all values.\n  if (nonNullCount > 0 && 'Sum' in calculations) {\n    calculations.Sum = sum;\n  }\n\n  if (nonNullCount > 0 && 'Mean' in calculations) {\n    calculations.Mean = sum / nonNullCount;\n  }\n\n  return calculations;\n}\n\n/**\n * Calculate a single value for a set of time series data.\n *\n * Use `getCalculations` instead if you need multiple calculations.\n *\n * @param values - Array of time series data.\n * @param calculation - Name of the calculation to calculate.\n */\nexport function getCalculation(values: TimeSeriesValueTuple[], calculation: CalculationType) {\n  return getCalculations(values, [calculation])[calculation];\n}\n\nfunction first(values: TimeSeriesValueTuple[]): CalculationValue {\n  return getCalculation(values, 'First');\n}\n\nfunction last(values: TimeSeriesValueTuple[]): CalculationValue {\n  return getCalculation(values, 'Last');\n}\n\nfunction firstNumber(values: TimeSeriesValueTuple[]): CalculationValue {\n  return getCalculation(values, 'FirstNumber');\n}\n\nfunction lastNumber(values: TimeSeriesValueTuple[]): CalculationValue {\n  return getCalculation(values, 'LastNumber');\n}\n\nfunction mean(values: TimeSeriesValueTuple[]): CalculationValue {\n  return getCalculation(values, 'Mean');\n}\n\nfunction sum(values: TimeSeriesValueTuple[]): CalculationValue {\n  return getCalculation(values, 'Sum');\n}\n\nfunction min(values: TimeSeriesValueTuple[]): CalculationValue {\n  return getCalculation(values, 'Min');\n}\n\nfunction max(values: TimeSeriesValueTuple[]): CalculationValue {\n  return getCalculation(values, 'Max');\n}\n"],"names":["CalculationsMap","First","first","Last","last","FirstNumber","firstNumber","LastNumber","lastNumber","Mean","mean","Sum","sum","Min","min","Max","max","CALCULATIONS_CONFIG","label","description","DEFAULT_CALCULATION","getCalculations","values","includeCalculations","calculations","reduce","initResult","calculation","undefined","nonNullCount","forEach","tuple","i","value","length","Math","getCalculation"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAIjC,OAAO,MAAMA,eAAe,GAAG;IAC7BC,KAAK,EAAEC,KAAK;IACZC,IAAI,EAAEC,IAAI;IACVC,WAAW,EAAEC,WAAW;IACxBC,UAAU,EAAEC,UAAU;IACtBC,IAAI,EAAEC,IAAI;IACVC,GAAG,EAAEC,GAAG;IACRC,GAAG,EAAEC,GAAG;IACRC,GAAG,EAAEC,GAAG;CACT,CAAC;AASF,OAAO,MAAMC,mBAAmB,GAAyD;IACvFhB,KAAK,EAAE;QACLiB,KAAK,EAAE,OAAO;QACdC,WAAW,EAAE,aAAa;KAC3B;IACDhB,IAAI,EAAE;QACJe,KAAK,EAAE,MAAM;QACbC,WAAW,EAAE,YAAY;KAC1B;IACDd,WAAW,EAAE;QACXa,KAAK,EAAE,SAAS;QAChBC,WAAW,EAAE,qBAAqB;KACnC;IACDZ,UAAU,EAAE;QACVW,KAAK,EAAE,QAAQ;QACfC,WAAW,EAAE,oBAAoB;KAClC;IACDV,IAAI,EAAE;QACJS,KAAK,EAAE,SAAS;QAChBC,WAAW,EAAE,+BAA+B;KAC7C;IACDR,GAAG,EAAE;QACHO,KAAK,EAAE,KAAK;QACZC,WAAW,EAAE,uBAAuB;KACrC;IACDN,GAAG,EAAE;QACHK,KAAK,EAAE,KAAK;QACZC,WAAW,EAAE,eAAe;KAC7B;IACDJ,GAAG,EAAE;QACHG,KAAK,EAAE,KAAK;QACZC,WAAW,EAAE,eAAe;KAC7B;CACF,AAAS,CAAC;AAEX,OAAO,MAAMC,mBAAmB,GAAoB,KAAK,CAAC;AAI1D;;;;;CAKC,GACD,OAAO,SAASC,eAAe,CAC7BC,MAA8B,EAC9BC,mBAAiC,EAMjC;IACA,MAAMC,YAAY,GAAGD,mBAAmB,CAACE,MAAM,CAAC,CAACC,UAAU,EAAEC,WAAW,GAAK;QAC3ED,UAAU,CAACC,WAAW,CAAC,GAAGC,SAAS,CAAC;QACpC,OAAOF,UAAU,CAAC;IACpB,CAAC,EAAE,EAAE,CAAqC,AAAC;IAE3C,2EAA2E;IAC3E,wEAAwE;IACxE,IAAIG,YAAY,GAAG,CAAC,AAAC;IACrB,IAAIjB,GAAG,GAAG,CAAC,AAAC;IAEZ,4EAA4E;IAC5E,0EAA0E;IAC1E,wEAAwE;IACxE,8EAA8E;IAC9E,yEAAyE;IACzE,sDAAsD;IACtDU,MAAM,CAACQ,OAAO,CAAC,CAACC,KAAK,EAAEC,CAAC,GAAK;QAC3B,MAAMC,KAAK,GAAGF,KAAK,CAAC,CAAC,CAAC,AAAC;QAEvB,IAAIC,CAAC,KAAK,CAAC,IAAI,OAAO,IAAIR,YAAY,EAAE;YACtCA,YAAY,CAACvB,KAAK,GAAGgC,KAAK,CAAC;QAC7B,CAAC;QACD,IAAID,CAAC,KAAKV,MAAM,CAACY,MAAM,GAAG,CAAC,IAAI,MAAM,IAAIV,YAAY,EAAE;YACrDA,YAAY,CAACrB,IAAI,GAAG8B,KAAK,CAAC;QAC5B,CAAC;QAED,wCAAwC;QACxC,IAAI,OAAOA,KAAK,KAAK,QAAQ,EAAE;YAC7BJ,YAAY,IAAI,CAAC,CAAC;YAClBjB,GAAG,IAAIqB,KAAK,CAAC;YAEb,IAAI,aAAa,IAAIT,YAAY,IAAIA,YAAY,CAACnB,WAAW,KAAKuB,SAAS,EAAE;gBAC3E,gCAAgC;gBAChCJ,YAAY,CAACnB,WAAW,GAAG4B,KAAK,CAAC;YACnC,CAAC;YAED,IAAI,YAAY,IAAIT,YAAY,EAAE;gBAChC,uEAAuE;gBACvE,uCAAuC;gBACvCA,YAAY,CAACjB,UAAU,GAAG0B,KAAK,CAAC;YAClC,CAAC;YAED,IAAI,KAAK,IAAIT,YAAY,EAAE;gBACzB,IAAI,OAAOA,YAAY,CAACX,GAAG,KAAK,QAAQ,EAAE;oBACxC,sCAAsC;oBACtCW,YAAY,CAACX,GAAG,GAAGoB,KAAK,CAAC;gBAC3B,OAAO;oBACL,oCAAoC;oBACpCT,YAAY,CAACX,GAAG,GAAGsB,IAAI,CAACrB,GAAG,CAACU,YAAY,CAACX,GAAG,EAAEoB,KAAK,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC;YAED,IAAI,KAAK,IAAIT,YAAY,EAAE;gBACzB,IAAI,OAAOA,YAAY,CAACT,GAAG,KAAK,QAAQ,EAAE;oBACxC,sCAAsC;oBACtCS,YAAY,CAACT,GAAG,GAAGkB,KAAK,CAAC;gBAC3B,OAAO;oBACL,qCAAqC;oBACrCT,YAAY,CAACT,GAAG,GAAGoB,IAAI,CAACnB,GAAG,CAACQ,YAAY,CAACT,GAAG,EAAEkB,KAAK,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,2DAA2D;IAC3D,IAAIJ,YAAY,GAAG,CAAC,IAAI,KAAK,IAAIL,YAAY,EAAE;QAC7CA,YAAY,CAACb,GAAG,GAAGC,GAAG,CAAC;IACzB,CAAC;IAED,IAAIiB,YAAY,GAAG,CAAC,IAAI,MAAM,IAAIL,YAAY,EAAE;QAC9CA,YAAY,CAACf,IAAI,GAAGG,GAAG,GAAGiB,YAAY,CAAC;IACzC,CAAC;IAED,OAAOL,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;CAOC,GACD,OAAO,SAASY,cAAc,CAACd,MAA8B,EAAEK,WAA4B,EAAE;IAC3F,OAAON,eAAe,CAACC,MAAM,EAAE;QAACK,WAAW;KAAC,CAAC,CAACA,WAAW,CAAC,CAAC;AAC7D,CAAC;AAED,SAASzB,KAAK,CAACoB,MAA8B,EAAoB;IAC/D,OAAOc,cAAc,CAACd,MAAM,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC;AAED,SAASlB,IAAI,CAACkB,MAA8B,EAAoB;IAC9D,OAAOc,cAAc,CAACd,MAAM,EAAE,MAAM,CAAC,CAAC;AACxC,CAAC;AAED,SAAShB,WAAW,CAACgB,MAA8B,EAAoB;IACrE,OAAOc,cAAc,CAACd,MAAM,EAAE,aAAa,CAAC,CAAC;AAC/C,CAAC;AAED,SAASd,UAAU,CAACc,MAA8B,EAAoB;IACpE,OAAOc,cAAc,CAACd,MAAM,EAAE,YAAY,CAAC,CAAC;AAC9C,CAAC;AAED,SAASZ,IAAI,CAACY,MAA8B,EAAoB;IAC9D,OAAOc,cAAc,CAACd,MAAM,EAAE,MAAM,CAAC,CAAC;AACxC,CAAC;AAED,SAASV,GAAG,CAACU,MAA8B,EAAoB;IAC7D,OAAOc,cAAc,CAACd,MAAM,EAAE,KAAK,CAAC,CAAC;AACvC,CAAC;AAED,SAASR,GAAG,CAACQ,MAA8B,EAAoB;IAC7D,OAAOc,cAAc,CAACd,MAAM,EAAE,KAAK,CAAC,CAAC;AACvC,CAAC;AAED,SAASN,GAAG,CAACM,MAA8B,EAAoB;IAC7D,OAAOc,cAAc,CAACd,MAAM,EAAE,KAAK,CAAC,CAAC;AACvC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@perses-dev/core",
-  "version": "0.34.0",
+  "version": "0.35.0",
   "description": "Core functionality consumed by both the Perses UI and plugins",
   "license": "Apache-2.0",
   "homepage": "https://github.com/perses/perses/blob/main/README.md",