All files / src/pages/flowsheet-page/economics/default-rates economicsDefaultRates.ts

65.06% Statements 54/83
55.95% Branches 47/84
87.5% Functions 7/8
72.6% Lines 53/73

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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385                        103x   103x                                                         133x 798x                   17x       102x                             102x 102x 102x               17x             17x     102x                                               5x 5x 5x                           89x                             89x 267x   89x 89x                     10608x       695x   973x       160x         160x     160x                                 160x               160x 160x 160x 160x                                           887x                           887x     887x 6309x                         887x   1197x                   887x                                       887x     60x   827x   282x   545x                           1622x       3396x       342x               342x                         10x                                                         89x       102x 102x 102x 102x    
import type {
  EconomicsDefaultRateRead,
  EconomicsSettingsProfileRead,
} from "@/api/apiStore.gen";
import {
  OperatingCostLineCategoryEnum,
  RateTypeEnum,
  ReviewStatusEnum,
  ValueKindEnum,
} from "@/api/apiStore.gen";
import { MAINTENANCE_RATE_UNIT } from "../operating-lines-panel/model/types";
 
export const CUSTOM_DEFAULT_RATE_VALUE = "__custom__";
 
export const DEFAULT_RATE_TYPES = [
  RateTypeEnum.Electricity,
  RateTypeEnum.NaturalGas,
  RateTypeEnum.FuelOil,
  RateTypeEnum.Diesel,
  RateTypeEnum.Steam,
  RateTypeEnum.Maintenance,
] as const;
 
export type DefaultRateType = (typeof DEFAULT_RATE_TYPES)[number];
 
export type DefaultRateOverrideDraft = {
  mode: "source" | "custom";
  source_default_rate: string;
  value: string;
  unit: string;
  boiler_efficiency_percent?: string;
  steam_energy_gj_per_t?: string;
};
 
export type DefaultRateOverridesDraft = Record<
  DefaultRateType,
  DefaultRateOverrideDraft
>;
 
export function defaultRateOverridesDraftFromRead(
  assumptions: EconomicsSettingsProfileRead | undefined,
  defaultRates: EconomicsDefaultRateRead[],
): DefaultRateOverridesDraft {
  return Object.fromEntries(
    DEFAULT_RATE_TYPES.map((rateType) => [
      rateType,
      defaultRateOverrideDraftForType(rateType, assumptions, defaultRates),
    ]),
  ) as DefaultRateOverridesDraft;
}
 
export function serializeDefaultRateOverrides(
  draft: DefaultRateOverridesDraft,
) {
  return Object.fromEntries(
    DEFAULT_RATE_TYPES.flatMap<
      [DefaultRateType, SerializedDefaultRateOverride]
    >((rateType) => {
      const override = draft[rateType];
      if (override.mode === "custom") {
        Iif (!override.value.trim()) return [];
        return [
          [
            rateType,
            {
              mode: "custom",
              source_default_rate: null,
              value: override.value.trim(),
              unit: override.unit.trim(),
            },
          ],
        ];
      }
      const sourceDefaultRate = nullableNumber(override.source_default_rate);
      Iif (sourceDefaultRate == null) return [];
      const sourceOverride: SerializedDefaultRateOverride = {
        mode: "source",
        source_default_rate: sourceDefaultRate,
      };
      if (
        rateType === RateTypeEnum.Steam &&
        override.boiler_efficiency_percent?.trim()
      ) {
        sourceOverride.boiler_efficiency_percent =
          override.boiler_efficiency_percent.trim();
      }
      if (
        rateType === RateTypeEnum.Steam &&
        override.steam_energy_gj_per_t?.trim()
      ) {
        sourceOverride.steam_energy_gj_per_t =
          override.steam_energy_gj_per_t.trim();
      }
      return [[rateType, sourceOverride]];
    }),
  );
}
 
type SerializedDefaultRateOverride =
  | {
      mode: "custom";
      source_default_rate: null;
      value: string;
      unit: string;
    }
  | {
      mode: "source";
      source_default_rate: number;
      boiler_efficiency_percent?: string;
      steam_energy_gj_per_t?: string;
    };
 
export function selectedOperatingDefaultForCategory(
  category: OperatingCostLineCategoryEnum,
  assumptions: EconomicsSettingsProfileRead | null | undefined,
  defaultRates: EconomicsDefaultRateRead[],
) {
  const rateType = rateTypeForCategory(category);
  Iif (!rateType) return undefined;
  return selectedOperatingDefaultForRateType(
    rateType,
    category,
    assumptions,
    defaultRates,
  );
}
 
export function selectedOperatingDefaultForRateType(
  rateType: RateTypeEnum,
  category: OperatingCostLineCategoryEnum,
  assumptions: EconomicsSettingsProfileRead | null | undefined,
  defaultRates: EconomicsDefaultRateRead[],
) {
  const draft = defaultRateOverrideDraftForType(
    rateType,
    assumptions ?? undefined,
    defaultRates,
  );
  if (draft.mode === "custom") {
    return {
      sourceDefaultRate: null,
      rateAmount: defaultRateCustomAmountForCategory(category, draft),
      rateUnit: defaultOperatingRateUnitForCategory(
        category,
        draft.unit.trim(),
      ),
    };
  }
  const rate = defaultRates.find(
    (candidate) => String(candidate.id) === draft.source_default_rate,
  );
  Iif (!rate) return undefined;
  return {
    sourceDefaultRate: rate,
    rateAmount: "",
    rateUnit: defaultOperatingRateUnitForCategory(category, rate.display_unit),
  };
}
 
export function sourceRatesForType(
  rateType: RateTypeEnum,
  defaultRates: EconomicsDefaultRateRead[],
) {
  return defaultRates.filter((rate) => rate.rate_type === rateType);
}
 
export function rateTypeLabel(rateType: string) {
  return rateType
    .replace(/_/g, " ")
    .replace(/\b\w/g, (letter) => letter.toUpperCase());
}
 
export function defaultRateOptionLabel(rate: EconomicsDefaultRateRead) {
  const value = rate.value
    ? formatDefaultRateValue(rate.value)
    : rate.rate_type === RateTypeEnum.Steam
      ? formatDefaultRateValue(rate.preview_value ?? "")
      : "";
  const rateText = value
    ? `${value} ${rate.display_unit}`.trim()
    : rateStatusLabel(rate);
  return [
    defaultRateDisplayLabel(rate),
    rate.source_label,
    rate.source_year,
    rateText,
  ]
    .filter(Boolean)
    .join(" ยท ");
}
 
function defaultRateDisplayLabel(rate: EconomicsDefaultRateRead) {
  if (
    rate.rate_type === RateTypeEnum.Steam &&
    rate.value_kind === ValueKindEnum.DerivedTemplate
  ) {
    return capitalizeLabel(rate.label.replace(/^Steam derived,\s*/i, ""));
  }
  return rate.label;
}
 
function capitalizeLabel(label: string) {
  return label ? `${label.charAt(0).toUpperCase()}${label.slice(1)}` : label;
}
 
export function formatDefaultRateValue(value: string | null | undefined) {
  Iif (value == null || value === "") return "";
  const numericValue = Number(value);
  Iif (!Number.isFinite(numericValue)) return value;
  return new Intl.NumberFormat("en-NZ", {
    maximumFractionDigits: numericValue < 1 ? 4 : 2,
  }).format(numericValue);
}
 
export function defaultRateUnitForType(
  rateType: RateTypeEnum,
  assumptions: EconomicsSettingsProfileRead | undefined,
  defaultRates: EconomicsDefaultRateRead[] = [],
) {
  const backendOption = assumptions?.default_rate_unit_options?.[rateType]?.[0];
  Iif (backendOption?.value) return backendOption.value;
  return (
    defaultRates.find((rate) => rate.rate_type === rateType)?.display_unit ?? ""
  );
}
 
function defaultRateOverrideDraftForType(
  rateType: RateTypeEnum,
  assumptions: EconomicsSettingsProfileRead | undefined,
  defaultRates: EconomicsDefaultRateRead[],
): DefaultRateOverrideDraft {
  const saved = readDefaultRateOverride(assumptions, rateType);
  if (saved?.mode === "custom") {
    return {
      mode: "custom",
      source_default_rate: "",
      value: typeof saved.value === "string" ? saved.value : "",
      unit:
        typeof saved.unit === "string" && saved.unit.trim()
          ? saved.unit
          : defaultRateUnitForType(rateType, assumptions, defaultRates),
    };
  }
 
  const savedSourceId =
    saved?.mode === "source" && saved.source_default_rate != null
      ? String(saved.source_default_rate)
      : "";
  const savedSourceRate = defaultRates.find(
    (rate) => rate.rate_type === rateType && String(rate.id) === savedSourceId,
  );
  if (savedSourceId && !savedSourceRate) {
    return {
      mode: "source",
      source_default_rate: savedSourceId,
      value: "",
      unit: defaultRateUnitForType(rateType, assumptions, defaultRates),
      boiler_efficiency_percent: readString(saved?.boiler_efficiency_percent),
      steam_energy_gj_per_t: readString(saved?.steam_energy_gj_per_t),
    };
  }
  const sourceRate =
    savedSourceRate ??
    defaultRates.find(
      (rate) => rate.rate_type === rateType && isSelectableDefaultRate(rate),
    );
  if (!sourceRate) {
    return {
      mode: "custom",
      source_default_rate: "",
      value: "",
      unit: defaultRateUnitForType(rateType, assumptions, defaultRates),
    };
  }
  return {
    mode: "source",
    source_default_rate: String(sourceRate.id),
    value: sourceRate.value ?? "",
    unit:
      sourceRate.display_unit ||
      defaultRateUnitForType(rateType, assumptions, defaultRates),
    boiler_efficiency_percent:
      readString(saved?.boiler_efficiency_percent) ||
      metadataString(sourceRate?.metadata, "default_boiler_efficiency_percent"),
    steam_energy_gj_per_t:
      readString(saved?.steam_energy_gj_per_t) ||
      metadataString(sourceRate?.metadata, "steam_energy_gj_per_t"),
  };
}
 
function readDefaultRateOverride(
  assumptions: EconomicsSettingsProfileRead | undefined,
  rateType: RateTypeEnum,
) {
  const overrides = (assumptions as { default_rate_overrides?: unknown })
    ?.default_rate_overrides;
  if (!overrides || typeof overrides !== "object" || Array.isArray(overrides)) {
    return undefined;
  }
  const override = (overrides as Record<string, unknown>)[rateType];
  if (!override || typeof override !== "object" || Array.isArray(override)) {
    return undefined;
  }
  return override as {
    mode?: string;
    source_default_rate?: string | number | null;
    value?: string;
    unit?: string;
    boiler_efficiency_percent?: string;
    steam_energy_gj_per_t?: string;
  };
}
 
function metadataString(metadata: unknown, key: string) {
  if (!metadata || typeof metadata !== "object" || Array.isArray(metadata)) {
    return "";
  }
  return readString((metadata as Record<string, unknown>)[key]);
}
 
function readString(value: unknown) {
  return typeof value === "string" ? value : "";
}
 
function isReviewedNumericDefault(rate: EconomicsDefaultRateRead) {
  return (
    rate.review_status === ReviewStatusEnum.Reviewed &&
    rate.value_kind === ValueKindEnum.ReviewedDefault &&
    rate.is_numeric_default_available
  );
}
 
function isSelectableDefaultRate(rate: EconomicsDefaultRateRead) {
  return isReviewedNumericDefault(rate) || rate.is_derived_template;
}
 
function rateStatusLabel(rate: EconomicsDefaultRateRead) {
  return rate.is_derived_template
    ? "Derived template"
    : rate.is_unavailable
      ? "Unavailable"
      : "No numeric default";
}
 
export function rateTypeForCategory(category: OperatingCostLineCategoryEnum) {
  if (category === OperatingCostLineCategoryEnum.Energy) {
    return RateTypeEnum.Electricity;
  }
  if (category === OperatingCostLineCategoryEnum.Maintenance) {
    return RateTypeEnum.Maintenance;
  }
  return undefined;
}
 
function defaultRateCustomAmountForCategory(
  category: OperatingCostLineCategoryEnum,
  draft: DefaultRateOverrideDraft,
) {
  if (
    category === OperatingCostLineCategoryEnum.Maintenance &&
    draft.unit.trim().startsWith("%")
  ) {
    const parsed = Number(draft.value);
    Iif (Number.isFinite(parsed)) return String(parsed / 100);
  }
  return draft.value.trim();
}
 
function defaultOperatingRateUnitForCategory(
  category: OperatingCostLineCategoryEnum,
  fallbackUnit: string,
) {
  if (category === OperatingCostLineCategoryEnum.Maintenance) {
    return MAINTENANCE_RATE_UNIT;
  }
  return fallbackUnit;
}
 
function nullableNumber(value: string) {
  const trimmed = value.trim();
  Iif (!trimmed) return null;
  const parsed = Number(trimmed);
  return Number.isFinite(parsed) ? parsed : null;
}