@qrvey/utils 1.17.6 → 1.18.1

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.17.6*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.18.1*
 
 > Helper, Utils for all Qrvey Projects
 

package/dist/cjs/comparativeAnalysis/index.js

@@ -13,7 +13,9 @@ exports.mapOperatorToValidationType = mapOperatorToValidationType;
 exports.buildComparisonExpressionValue = buildComparisonExpressionValue;
 exports.buildComparativeChartComparison = buildComparativeChartComparison;
 exports.resolveDeltaDiffInfo = resolveDeltaDiffInfo;
+exports.computeDeltaCellContent = computeDeltaCellContent;
 const get_1 = require("../general/object/get");
+const format_1 = require("../format/format");
 exports.DELTA_COLUMN_PREFIX = "\u0394";
 exports.REFERENCE_COLUMN_MARKER = "\u25CF";
 function formatDeltaColumnCaption(caption) {
@@ -366,3 +368,100 @@ function resolveDeltaDiffInfo(dataField, comparativeVirtualColumns, getChartColu
     }
     return { origUniqueCode: "", diffIndex: -1 };
 }
+function computeDeltaCellContent(comparativeAnalisis, columnKey, rawValue, options) {
+    const match = columnKey.match(/^(.+?)__delta(?:_(\d+))?$/);
+    if (!match)
+        return { text: String(rawValue ?? ""), color: "#1f3864" };
+    const uniqueCode = match[1];
+    const deltaIndex = match[2] ? parseInt(match[2], 10) : 0;
+    const styles = comparativeAnalisis?.styles ?? {};
+    const diffCols = styles?.columnDiffs?.[uniqueCode] ?? [];
+    const diffStyle = diffCols[deltaIndex] ?? diffCols[0] ?? null;
+    const gs = styles;
+    const neutralColor = gs.neutralColor ?? "#1f3864";
+    const positiveColor = gs.positiveColor ?? "#52c41a";
+    const negativeColor = gs.negativeColor ?? "#f5222d";
+    const positiveIs = diffStyle?.positiveIs ?? gs.positiveIs ?? "higher";
+    const delta = -rawValue;
+    if (typeof delta !== "number" || !isFinite(delta)) {
+        return { text: "", color: neutralColor };
+    }
+    const increased = delta > 0;
+    const decreased = delta < 0;
+    const neutral = delta === 0;
+    const isPositive = positiveIs === "higher" ? increased : decreased;
+    let color;
+    if (neutral) {
+        color = neutralColor;
+    }
+    else if (isPositive) {
+        color = positiveColor;
+    }
+    else {
+        color = negativeColor;
+    }
+    const defaultOrder = [
+        "showTrendIcon",
+        "showPercent",
+        "showValue",
+        "showABCLabels",
+    ];
+    const order = diffStyle?.displayOrder?.length
+        ? diffStyle.displayOrder
+        : defaultOrder;
+    const showTrendIcon = diffStyle?.showTrendIcon ?? false;
+    const showPercent = diffStyle?.showPercent ?? true;
+    const showValue = diffStyle?.showValue ?? false;
+    const showABC = diffStyle?.showABCLabels ?? false;
+    const parts = [];
+    for (const flag of order) {
+        if (flag === "showTrendIcon" && showTrendIcon) {
+            if (increased)
+                parts.push("\u25B2");
+            else if (decreased)
+                parts.push("\u25BC");
+        }
+        else if (flag === "showPercent" && showPercent) {
+            const origNum = options?.originalValue;
+            if (origNum != null &&
+                typeof origNum === "number" &&
+                isFinite(origNum) &&
+                origNum !== 0) {
+                const pct = (delta / origNum) * 100;
+                const sign = pct > 0 ? "+" : "";
+                parts.push(`${sign}${pct.toFixed(1)}%`);
+            }
+        }
+        else if (flag === "showValue" && showValue) {
+            let sign;
+            if (delta > 0) {
+                sign = "+";
+            }
+            else if (delta < 0) {
+                sign = "-";
+            }
+            else {
+                sign = "";
+            }
+            const formattedAbs = options?.format
+                ? (0, format_1.addFormat)(Math.abs(delta), options.format, options.locale)
+                : Math.abs(delta).toLocaleString();
+            parts.push(`${sign}${formattedAbs}`);
+        }
+        else if (flag === "showABCLabels" && showABC) {
+            let abcLabel;
+            if (neutral) {
+                abcLabel = diffStyle?.neutralLabel ?? "";
+            }
+            else if (isPositive) {
+                abcLabel = diffStyle?.positiveLabel ?? "";
+            }
+            else {
+                abcLabel = diffStyle?.negativeLabel ?? "";
+            }
+            if (abcLabel)
+                parts.push(abcLabel);
+        }
+    }
+    return { text: parts.join(" "), color };
+}

package/dist/cjs/tokens/getCustomTokenBoxParse.js

@@ -11,6 +11,7 @@ function getCustomTokenBoxParse(customTokens) {
             tokensList[tokenKey] = customTokens[tokenKey].map((token) => ({
                 alias: token.label,
                 label: `{{customTokens${subGroup}.${token.key}}}`,
+                value: token.value,
             }));
         }
     }

package/dist/comparativeAnalysis/index.d.ts

@@ -22,3 +22,33 @@ export declare function resolveDeltaDiffInfo(dataField: string, comparativeVirtu
     origUniqueCode: string;
     diffIndex: number;
 };
+export interface IDifferenceColumnStyle {
+    id: string;
+    name: string;
+    positiveIs: "higher" | "lower";
+    showPercent: boolean;
+    showValue: boolean;
+    showTrendIcon: boolean;
+    showABCLabels: boolean;
+    positiveLabel: string;
+    negativeLabel: string;
+    neutralLabel: string;
+    displayOrder?: string[];
+}
+export interface IComparativeStyles {
+    columnDiffs: Record<string, IDifferenceColumnStyle[]>;
+    positiveIs: "higher" | "lower";
+    positiveColor: string;
+    negativeColor: string;
+    neutralColor: string;
+}
+export interface FormatDeltaCellOptions {
+    originalValue?: number;
+    format?: any;
+    locale?: any;
+}
+export interface DeltaCellContent {
+    text: string;
+    color: string;
+}
+export declare function computeDeltaCellContent(comparativeAnalisis: any, columnKey: string, rawValue: number, options?: FormatDeltaCellOptions): DeltaCellContent;

package/dist/comparativeAnalysis/index.js

@@ -1,4 +1,5 @@
 import { _get } from "../general/object/get";
+import { addFormat } from "../format/format";
 export const DELTA_COLUMN_PREFIX = "\u0394";
 export const REFERENCE_COLUMN_MARKER = "\u25CF";
 export function formatDeltaColumnCaption(caption) {
@@ -351,3 +352,100 @@ export function resolveDeltaDiffInfo(dataField, comparativeVirtualColumns, getCh
     }
     return { origUniqueCode: "", diffIndex: -1 };
 }
+export function computeDeltaCellContent(comparativeAnalisis, columnKey, rawValue, options) {
+    const match = columnKey.match(/^(.+?)__delta(?:_(\d+))?$/);
+    if (!match)
+        return { text: String(rawValue ?? ""), color: "#1f3864" };
+    const uniqueCode = match[1];
+    const deltaIndex = match[2] ? parseInt(match[2], 10) : 0;
+    const styles = comparativeAnalisis?.styles ?? {};
+    const diffCols = styles?.columnDiffs?.[uniqueCode] ?? [];
+    const diffStyle = diffCols[deltaIndex] ?? diffCols[0] ?? null;
+    const gs = styles;
+    const neutralColor = gs.neutralColor ?? "#1f3864";
+    const positiveColor = gs.positiveColor ?? "#52c41a";
+    const negativeColor = gs.negativeColor ?? "#f5222d";
+    const positiveIs = diffStyle?.positiveIs ?? gs.positiveIs ?? "higher";
+    const delta = -rawValue;
+    if (typeof delta !== "number" || !isFinite(delta)) {
+        return { text: "", color: neutralColor };
+    }
+    const increased = delta > 0;
+    const decreased = delta < 0;
+    const neutral = delta === 0;
+    const isPositive = positiveIs === "higher" ? increased : decreased;
+    let color;
+    if (neutral) {
+        color = neutralColor;
+    }
+    else if (isPositive) {
+        color = positiveColor;
+    }
+    else {
+        color = negativeColor;
+    }
+    const defaultOrder = [
+        "showTrendIcon",
+        "showPercent",
+        "showValue",
+        "showABCLabels",
+    ];
+    const order = diffStyle?.displayOrder?.length
+        ? diffStyle.displayOrder
+        : defaultOrder;
+    const showTrendIcon = diffStyle?.showTrendIcon ?? false;
+    const showPercent = diffStyle?.showPercent ?? true;
+    const showValue = diffStyle?.showValue ?? false;
+    const showABC = diffStyle?.showABCLabels ?? false;
+    const parts = [];
+    for (const flag of order) {
+        if (flag === "showTrendIcon" && showTrendIcon) {
+            if (increased)
+                parts.push("\u25B2");
+            else if (decreased)
+                parts.push("\u25BC");
+        }
+        else if (flag === "showPercent" && showPercent) {
+            const origNum = options?.originalValue;
+            if (origNum != null &&
+                typeof origNum === "number" &&
+                isFinite(origNum) &&
+                origNum !== 0) {
+                const pct = (delta / origNum) * 100;
+                const sign = pct > 0 ? "+" : "";
+                parts.push(`${sign}${pct.toFixed(1)}%`);
+            }
+        }
+        else if (flag === "showValue" && showValue) {
+            let sign;
+            if (delta > 0) {
+                sign = "+";
+            }
+            else if (delta < 0) {
+                sign = "-";
+            }
+            else {
+                sign = "";
+            }
+            const formattedAbs = options?.format
+                ? addFormat(Math.abs(delta), options.format, options.locale)
+                : Math.abs(delta).toLocaleString();
+            parts.push(`${sign}${formattedAbs}`);
+        }
+        else if (flag === "showABCLabels" && showABC) {
+            let abcLabel;
+            if (neutral) {
+                abcLabel = diffStyle?.neutralLabel ?? "";
+            }
+            else if (isPositive) {
+                abcLabel = diffStyle?.positiveLabel ?? "";
+            }
+            else {
+                abcLabel = diffStyle?.negativeLabel ?? "";
+            }
+            if (abcLabel)
+                parts.push(abcLabel);
+        }
+    }
+    return { text: parts.join(" "), color };
+}

package/dist/interfaces/CustomTokens.interface.d.ts

@@ -12,6 +12,7 @@ export interface ICustomTokensComplex {
 export interface ICustomTokensBoxDetail {
     alias: string;
     label: string;
+    value: string | number;
 }
 export interface ICustomTokensBox {
     [key: string]: ICustomTokensBoxDetail[];

package/dist/tokens/getCustomTokenBoxParse.js

@@ -8,6 +8,7 @@ export function getCustomTokenBoxParse(customTokens) {
             tokensList[tokenKey] = customTokens[tokenKey].map((token) => ({
                 alias: token.label,
                 label: `{{customTokens${subGroup}.${token.key}}}`,
+                value: token.value,
             }));
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/utils",
-  "version": "1.17.6",
+  "version": "1.18.1",
   "description": "Helper, Utils for all Qrvey Projects",
   "homepage": "https://bitbucket.org/qrvey/qrvey_utils/wiki/Home",
   "main": "dist/cjs/index.js",