v0.1.1: add support for custom crop types with user-defined EC ranges

Author: AdametherzLab

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adametherzlab/fertigation-mix-v2",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "fertigation-mix v2 — EC Target Range Calculator",
   "type": "module",
   "main": "./dist/index.js",

src/feature-1.ts

@@ -135,17 +135,36 @@ const SYSTEM_ADJUSTMENT_BASES: Record<HydroponicSystemType, Omit<SystemNutrientA
  * @param systemType - The type of hydroponic system in use
  * @param growthStage - Current growth stage of the crop
  * @param cropType - Identifier for the crop species or variety (e.g., 'tomato', 'lettuce')
+ * @param customRange - Optional user-defined EC range (min, max, and optional optimal) overriding system defaults
  * @returns Structured EC target range with min, max, optimal values and environmental modifiers
- * @throws {RangeError} If system type or growth stage is not supported
+ * @throws {RangeError} If system type or growth stage is not supported or invalid custom range
  * @example
  * const range = calculateEcTargetRange(HydroponicSystemType.NFT, GrowthStage.Vegetative, 'butter_lettuce');
  * console.log(range.optimalEc); // 1.47 (interpolated)
  */
 export function calculateEcTargetRange(
   systemType: HydroponicSystemType,
   growthStage: GrowthStage,
-  cropType: string
+  cropType: string,
+  customRange?: { min: number; max: number; optimal?: number }
 ): ECTargetRange {
+  if (customRange) {
+    if (customRange.min >= customRange.max) {
+      throw new RangeError('Custom EC range min must be less than max');
+    }
+
+    const optimalValue = customRange.optimal ?? customRange.min + (customRange.max - customRange.min) * 0.45;
+    
+    return {
+      cropType,
+      growthStage,
+      minEc: asElectricalConductivity(customRange.min),
+      maxEc: asElectricalConductivity(customRange.max),
+      optimalEc: asElectricalConductivity(Number(optimalValue.toFixed(2))),
+      environmentalModifiers: {}
+    } satisfies ECTargetRange;
+  }
+
   const systemRanges = EC_BASE_RANGES[systemType];
   if (!systemRanges) {
     throw new RangeError(`Unsupported hydroponic system type: ${String(systemType)}`);
@@ -197,51 +216,3 @@ export function classifyEcReading(
   // Check if within optimal band (±10% of optimal value)
   const optimalTolerance = targetRange.optimalEc * 0.1;
   if (Math.abs(reading - targetRange.optimalEc) <= optimalTolerance) return 'optimal';
-  
-  // Within min-max range but outside optimal band
-  return reading < targetRange.optimalEc ? 'suboptimal' : 'elevated';
-}
-
-/**
- * Retrieve system-specific nutrient adjustment profile modified for the given growth stage.
- * Adjusts EC multipliers and scheduling intervals based on plant nutritional demands.
- * @param systemType - The hydroponic system type
- * @param growthStage - The plant growth stage affecting nutrient uptake rates
- * @returns System nutrient adjustment parameters including EC multipliers and maintenance intervals
- * @throws {RangeError} If system type or growth stage is invalid
- * @example
- * const profile = getSystemNutrientAdjustment(HydroponicSystemType.DWC, GrowthStage.Fruiting);
- * // Returns profile with elevated EC multiplier for fruiting stage
- */
-export function getSystemNutrientAdjustment(
-  systemType: HydroponicSystemType,
-  growthStage: GrowthStage
-): SystemNutrientAdjustment {
-  const baseProfile = SYSTEM_ADJUSTMENT_BASES[systemType];
-  if (!baseProfile) {
-    throw new RangeError(`Invalid system type: ${String(systemType)}`);
-  }
-
-  // Stage-specific nutritional demand factors
-  const stageDemandFactors: Record<GrowthStage, number> = {
-    [GrowthStage.Seedling]: 0.7,
-    [GrowthStage.Vegetative]: 1.0,
-    [GrowthStage.Flowering]: 1.1,
-    [GrowthStage.Fruiting]: 1.2,
-    [GrowthStage.Ripening]: 0.9
-  };
-
-  const demandFactor = stageDemandFactors[growthStage];
-  if (demandFactor === undefined) {
-    throw new RangeError(`Invalid growth stage: ${String(growthStage)}`);
-  }
-
-  return {
-    systemType,
-    ecMultiplier: Number((baseProfile.ecMultiplier * demandFactor).toFixed(3)),
-    phOffset: baseProfile.phOffset,
-    oxygenDemandFactor: baseProfile.oxygenDemandFactor,
-    solutionChangeIntervalHours: baseProfile.solutionChangeIntervalHours,
-    topUpFrequencyHours: baseProfile.topUpFrequencyHours
-  } satisfies SystemNutrientAdjustment;
-}

tests/index.test.ts

@@ -30,6 +30,32 @@ describe("fertigation-mix-v2 comprehensive test suite", () => {
     expect(result.optimalEc).toBeLessThanOrEqual(result.maxEc);
   });
 
+  it("supports custom crop types with user-defined EC ranges", () => {
+    const result = calculateEcTargetRange(
+      HydroponicSystemType.DeepWaterCulture,
+      GrowthStage.Vegetative,
+      "custom_crop",
+      { min: 1.0, max: 2.0 }
+    );
+
+    expect(result.cropType).toBe("custom_crop");
+    expect(result.growthStage).toBe(GrowthStage.Vegetative);
+    expect(result.minEc).toBe(1.0);
+    expect(result.maxEc).toBe(2.0);
+    expect(result.optimalEc).toBeCloseTo(1.45);
+  });
+
+  it("uses provided optimal EC in custom ranges", () => {
+    const result = calculateEcTargetRange(
+      HydroponicSystemType.DeepWaterCulture,
+      GrowthStage.Vegetative,
+      "custom_crop",
+      { min: 1.0, max: 2.0, optimal: 1.8 }
+    );
+
+    expect(result.optimalEc).toBe(1.8);
+  });
+
   it("classifyEcReading categorizes readings correctly at classification boundaries", () => {
     const range: ECTargetRange = {
       cropType: "tomato",
@@ -104,4 +130,4 @@ describe("fertigation-mix-v2 comprehensive test suite", () => {
     expect(result.volumePerLiterMl).toBe(1000);
     expect(result.safetyWarning).toInclude("Causes stem elongation");
   });
-});
+});