All files / src/pages/flowsheet-page/economics/settings-panel/model settingsValidation.ts

48.38% Statements 15/31
89.65% Branches 26/29
100% Functions 1/1
48.38% Lines 15/31

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193                            76x                                         76x                             5x                                                                                                                                                                           5x           4x 4x                               4x           15x   10x       11x     15x       13x           4x 1x         5x    
import { RateTypeEnum } from "@/api/apiStore.gen";
import { rateTypeLabel } from "../../default-rates/economicsDefaultRates";
import type {
  AssumptionsDraft,
  BaselineDraft,
  FieldMessages,
} from "./settingsTypes";
import {
  isFiniteNumber,
  isPercentValue,
  isPositiveFiniteNumber,
  nullablePositiveInteger,
} from "./settingsValueUtils";
 
export const ASSUMPTION_FIELD_KEYS = [
  "currency",
  "location",
  "basis_date",
  "discount_rate_percent",
  "project_lifetime_years",
  "inflation_method",
  "annual_operating_hours",
  "tax_rate_percent",
  "depreciation_enabled",
  "default_depreciation_life_years",
  "default_depreciation_salvage_percent",
  "contingency_percent",
  "electrical_upgrade_rate_amount",
  "default_lang_factor",
  "capital_index_series",
  "operating_index_series",
  "default_rate_overrides",
  "notes",
] as const satisfies readonly (keyof AssumptionsDraft)[];
 
export const BASELINE_FIELD_KEYS = [
  "manual_capex",
  "manual_annual_opex",
  "annual_heat_basis_mode",
  "manual_annual_heat_basis",
  "manual_annual_heat_basis_unit",
  "average_power_input",
  "average_power_unit",
  "residual_value",
  "notes",
] as const satisfies readonly (keyof BaselineDraft)[];
 
export function validateAssumptionsDraft(
  draft: AssumptionsDraft,
): FieldMessages<AssumptionsDraft> {
  const messages: FieldMessages<AssumptionsDraft> = {};
  if (!draft.currency.trim()) {
    messages.currency = "Currency is required.";
  }
  if (
    draft.discount_rate_percent &&
    !isFiniteNumber(draft.discount_rate_percent)
  ) {
    messages.discount_rate_percent = "Discount rate must be a finite number.";
  }
  if (
    draft.project_lifetime_years &&
    nullablePositiveInteger(draft.project_lifetime_years) == null
  ) {
    messages.project_lifetime_years =
      "Project lifetime must be a positive whole number.";
  }
  if (
    draft.annual_operating_hours &&
    !isPositiveFiniteNumber(draft.annual_operating_hours)
  ) {
    messages.annual_operating_hours =
      "Annual operating hours must be a positive finite number.";
  }
  if (draft.tax_rate_percent && !isPercentValue(draft.tax_rate_percent)) {
    messages.tax_rate_percent = "Corporate tax rate must be between 0 and 100.";
  }
  if (
    draft.depreciation_enabled &&
    nullablePositiveInteger(draft.default_depreciation_life_years) == null
  ) {
    messages.default_depreciation_life_years =
      "Default equipment life must be a positive whole number.";
  }
  if (
    draft.default_depreciation_salvage_percent &&
    !isPercentValue(draft.default_depreciation_salvage_percent)
  ) {
    messages.default_depreciation_salvage_percent =
      "Default residual value must be between 0 and 100.";
  }
  if (
    draft.electrical_upgrade_rate_amount &&
    !isFiniteNumber(draft.electrical_upgrade_rate_amount)
  ) {
    messages.electrical_upgrade_rate_amount =
      "Electrical upgrade rate must be a finite number.";
  }
  if (draft.default_lang_factor && !isFiniteNumber(draft.default_lang_factor)) {
    messages.default_lang_factor =
      "Default Lang factor must be a finite number.";
  }
  for (const [rateType, override] of Object.entries(
    draft.default_rate_overrides,
  )) {
    if (
      override.mode === "custom" &&
      override.value &&
      !isFiniteNumber(override.value)
    ) {
      messages.default_rate_overrides = `${rateTypeLabel(
        rateType as RateTypeEnum,
      )} custom value must be a finite number.`;
      break;
    }
    if (
      rateType === RateTypeEnum.Steam &&
      override.mode === "source" &&
      override.boiler_efficiency_percent &&
      !isPositiveFiniteNumber(override.boiler_efficiency_percent)
    ) {
      messages.default_rate_overrides =
        "Steam boiler efficiency must be a positive finite number.";
      break;
    }
    if (
      rateType === RateTypeEnum.Steam &&
      override.mode === "source" &&
      override.steam_energy_gj_per_t &&
      !isPositiveFiniteNumber(override.steam_energy_gj_per_t)
    ) {
      messages.default_rate_overrides =
        "Steam energy basis must be a positive finite number.";
      break;
    }
  }
  return messages;
}
 
export function validateBaselineDraft(
  draft: BaselineDraft,
): FieldMessages<BaselineDraft> {
  const messages: FieldMessages<BaselineDraft> = {};
  const decimalFields = [
    ["manual_capex", "Baseline capex", draft.manual_capex],
    ["manual_annual_opex", "Annual opex", draft.manual_annual_opex],
    [
      "manual_annual_heat_basis",
      "Annual heat quantity",
      draft.manual_annual_heat_basis,
    ],
    ["average_power_input", "Hourly heat quantity", draft.average_power_input],
    ["residual_value", "Residual value", draft.residual_value],
  ] as const;
  for (const [field, label, value] of decimalFields) {
    if (value && !isFiniteNumber(value)) {
      messages[field] = `${label} must be a finite number.`;
    }
  }
  return messages;
}
 
export function baselineFieldWarnings(
  draft: BaselineDraft,
): FieldMessages<BaselineDraft> {
  const messages: FieldMessages<BaselineDraft> = {};
  if (!draft.manual_capex.trim()) {
    messages.manual_capex =
      "Required before dependent baseline metrics can be calculated.";
  }
  if (!draft.manual_annual_opex.trim()) {
    messages.manual_annual_opex =
      "Required before dependent savings metrics can be calculated.";
  }
  return messages;
}
 
export function emptyAssumptionFieldMessages(): FieldMessages<AssumptionsDraft> {
  return {};
}
 
export function hasBlockingBaselineErrors(
  messages: FieldMessages<BaselineDraft>,
) {
  return Object.values(messages).some((message) =>
    message?.includes("must be a finite number"),
  );
}
 
export function hasMessages(messages: FieldMessages<AssumptionsDraft>) {
  return Object.values(messages).some(Boolean);
}