@reekon-tools/boldr-utils 1.3.5 → 1.3.7

package/README.md

@@ -10,3 +10,11 @@ BOLDR Utils is a collection of types and utility functions written to be used ac
 - Be consumable in Remix (Node/ESM, often using Vite or Webpack)
 - Be written in TypeScript
 - Be published cleanly to npm
+
+## Publishing
+
+To publish the package to NPM, be sure to build it. Then, run
+
+```
+npm publish --access public
+```

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export { convertMicrometers } from './utils/micrometersToUnit.js';
 export { parseMeasurement } from './utils/parseMeasurement.js';
 export { useParseMeasurement } from './hooks/useParseMeasurement.js';
 export * from './types/firestore.js';
+export { getToleranceColor, calculateDeviationPercentage, isWithinTolerance, generateToleranceGradient, createDefaultToleranceThresholds, DEFAULT_TOLERANCE_COLORS, type ToleranceThreshold, type ToleranceConfig, } from './utils/tolerance.js';

package/dist/index.js

@@ -3,3 +3,4 @@ export { convertMicrometers } from './utils/micrometersToUnit.js';
 export { parseMeasurement } from './utils/parseMeasurement.js';
 export { useParseMeasurement } from './hooks/useParseMeasurement.js';
 export * from './types/firestore.js';
+export { getToleranceColor, calculateDeviationPercentage, isWithinTolerance, generateToleranceGradient, createDefaultToleranceThresholds, DEFAULT_TOLERANCE_COLORS, } from './utils/tolerance.js';

package/dist/utils/tolerance.d.ts

@@ -0,0 +1,62 @@
+export interface ToleranceThreshold {
+    id: string;
+    percentage: number;
+    color: string;
+}
+export interface ToleranceConfig {
+    thresholds: ToleranceThreshold[];
+    updatedAt?: Date | {
+        toDate(): Date;
+    };
+}
+/**
+ * Default colors for tolerance visualization
+ */
+export declare const DEFAULT_TOLERANCE_COLORS: {
+    readonly IN_TOLERANCE: "#22c55e";
+    readonly OUT_OF_TOLERANCE: "#ef4444";
+};
+/**
+ * Calculates the appropriate color for a measurement based on tolerance thresholds
+ *
+ * @param actualValue - The measured value
+ * @param target - The target/nominal value
+ * @param min - The minimum acceptable value (used as negative tolerance from target)
+ * @param max - The maximum acceptable value (used as positive tolerance from target)
+ * @param toleranceConfig - Optional tolerance configuration with custom thresholds
+ * @returns The color hex string to use for the measurement
+ */
+export declare function getToleranceColor(actualValue: number, target: number, min: number, max: number, toleranceConfig?: ToleranceConfig | null): string;
+/**
+ * Calculates the deviation percentage of a measurement from its target
+ *
+ * @param actualValue - The measured value
+ * @param target - The target/nominal value
+ * @param min - The minimum acceptable value
+ * @param max - The maximum acceptable value
+ * @returns The deviation as a percentage of the tolerance range
+ */
+export declare function calculateDeviationPercentage(actualValue: number, target: number, min: number, max: number): number;
+/**
+ * Checks if a measurement is within tolerance bounds
+ *
+ * @param actualValue - The measured value
+ * @param target - The target/nominal value
+ * @param min - The minimum acceptable value
+ * @param max - The maximum acceptable value
+ * @returns True if the measurement is within bounds
+ */
+export declare function isWithinTolerance(actualValue: number, target: number, min: number, max: number): boolean;
+/**
+ * Generates a CSS gradient string for visualizing tolerance thresholds
+ *
+ * @param thresholds - Array of tolerance thresholds
+ * @returns CSS linear-gradient string
+ */
+export declare function generateToleranceGradient(thresholds: ToleranceThreshold[]): string;
+/**
+ * Creates default tolerance thresholds
+ *
+ * @returns Array of default tolerance thresholds
+ */
+export declare function createDefaultToleranceThresholds(): ToleranceThreshold[];

package/dist/utils/tolerance.js

@@ -0,0 +1,113 @@
+/**
+ * Default colors for tolerance visualization
+ */
+export const DEFAULT_TOLERANCE_COLORS = {
+    IN_TOLERANCE: '#22c55e', // Green
+    OUT_OF_TOLERANCE: '#ef4444', // Red
+};
+/**
+ * Calculates the appropriate color for a measurement based on tolerance thresholds
+ *
+ * @param actualValue - The measured value
+ * @param target - The target/nominal value
+ * @param min - The minimum acceptable value (used as negative tolerance from target)
+ * @param max - The maximum acceptable value (used as positive tolerance from target)
+ * @param toleranceConfig - Optional tolerance configuration with custom thresholds
+ * @returns The color hex string to use for the measurement
+ */
+export function getToleranceColor(actualValue, target, min, max, toleranceConfig) {
+    // If no tolerance config provided, use simple green/red logic
+    if (!toleranceConfig?.thresholds || toleranceConfig.thresholds.length === 0) {
+        const isWithinTolerance = actualValue >= target - min && actualValue <= target + max;
+        return isWithinTolerance
+            ? DEFAULT_TOLERANCE_COLORS.IN_TOLERANCE
+            : DEFAULT_TOLERANCE_COLORS.OUT_OF_TOLERANCE;
+    }
+    // Calculate deviation percentage
+    const deviation = Math.abs(actualValue - target);
+    const toleranceRange = max + min; // Fixed: total tolerance range
+    const deviationPercentage = toleranceRange > 0 ? (deviation / toleranceRange) * 100 : 0;
+    // Sort thresholds by percentage to ensure correct evaluation order
+    const sortedThresholds = toleranceConfig.thresholds.sort((a, b) => a.percentage - b.percentage);
+    // If deviation is below the first threshold, it's in tolerance (green)
+    if (deviationPercentage < sortedThresholds[0].percentage) {
+        return DEFAULT_TOLERANCE_COLORS.IN_TOLERANCE;
+    }
+    // Find the highest threshold that the deviation exceeds
+    let applicableColor = sortedThresholds[0].color;
+    for (const threshold of sortedThresholds) {
+        if (deviationPercentage >= threshold.percentage) {
+            applicableColor = threshold.color;
+        }
+    }
+    return applicableColor;
+}
+/**
+ * Calculates the deviation percentage of a measurement from its target
+ *
+ * @param actualValue - The measured value
+ * @param target - The target/nominal value
+ * @param min - The minimum acceptable value
+ * @param max - The maximum acceptable value
+ * @returns The deviation as a percentage of the tolerance range
+ */
+export function calculateDeviationPercentage(actualValue, target, min, max) {
+    const deviation = Math.abs(actualValue - target);
+    const toleranceRange = max + min; // Fixed: total tolerance range
+    return toleranceRange > 0 ? (deviation / toleranceRange) * 100 : 0;
+}
+/**
+ * Checks if a measurement is within tolerance bounds
+ *
+ * @param actualValue - The measured value
+ * @param target - The target/nominal value
+ * @param min - The minimum acceptable value
+ * @param max - The maximum acceptable value
+ * @returns True if the measurement is within bounds
+ */
+export function isWithinTolerance(actualValue, target, min, max) {
+    return actualValue >= target - min && actualValue <= target + max;
+}
+/**
+ * Generates a CSS gradient string for visualizing tolerance thresholds
+ *
+ * @param thresholds - Array of tolerance thresholds
+ * @returns CSS linear-gradient string
+ */
+export function generateToleranceGradient(thresholds) {
+    const sortedThresholds = [...thresholds].sort((a, b) => a.percentage - b.percentage);
+    if (sortedThresholds.length === 0) {
+        return `linear-gradient(to right, ${DEFAULT_TOLERANCE_COLORS.IN_TOLERANCE} 100%)`;
+    }
+    const gradientStops = [];
+    // Green from 0% to first threshold
+    const firstThreshold = sortedThresholds[0];
+    if (firstThreshold.percentage > 0) {
+        gradientStops.push(`${DEFAULT_TOLERANCE_COLORS.IN_TOLERANCE} 0%`);
+        gradientStops.push(`${DEFAULT_TOLERANCE_COLORS.IN_TOLERANCE} ${firstThreshold.percentage}%`);
+    }
+    // Add each threshold color
+    sortedThresholds.forEach((threshold, index) => {
+        gradientStops.push(`${threshold.color} ${threshold.percentage}%`);
+        // If this isn't the last threshold, add the color up to the next threshold
+        const nextThreshold = sortedThresholds[index + 1];
+        if (nextThreshold) {
+            gradientStops.push(`${threshold.color} ${nextThreshold.percentage}%`);
+        }
+        else {
+            // Last threshold extends to 100%
+            gradientStops.push(`${threshold.color} 100%`);
+        }
+    });
+    return `linear-gradient(to right, ${gradientStops.join(', ')})`;
+}
+/**
+ * Creates default tolerance thresholds
+ *
+ * @returns Array of default tolerance thresholds
+ */
+export function createDefaultToleranceThresholds() {
+    return [
+        { id: '1', percentage: 25, color: '#ef4444' }, // Red at 25%
+    ];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reekon-tools/boldr-utils",
-  "version": "1.3.5",
+  "version": "1.3.7",
   "description": "Shared utilities for formulas and measurement conversion used in Reekon apps",
   "author": "REEKON Tools",
   "license": "MIT",