evcc-io/assets/js/settings.ts

import { reactive, watch } from "vue";
import type { THEME, SessionInfoKey } from "./types/evcc";
import type { LOCALES } from "./i18n";

const SETTINGS_LOCALE = "settings_locale";
const SETTINGS_THEME = "settings_theme";
const SETTINGS_UNIT = "settings_unit";
const SETTINGS_12H_FORMAT = "settings_12h_format";
const SETTINGS_ENERGYFLOW_DETAILS = "settings_energyflow_details";
const SETTINGS_ENERGYFLOW_CO2 = "settings_energyflow_co2";
const SETTINGS_ENERGYFLOW_PV = "settings_energyflow_pv";
const SETTINGS_ENERGYFLOW_BATTERY = "settings_energyflow_battery";
const SETTINGS_ENERGYFLOW_LOADPOINTS = "settings_energyflow_loadpoints";
const SETTINGS_ENERGYFLOW_CONSUMERS = "settings_energyflow_consumers";
const LOADPOINTS = "loadpoints";
const SESSION_COLUMNS = "session_columns";
const SAVINGS_PERIOD = "savings_period";
const SAVINGS_REGION = "savings_region";
const SAVINGS_INDICATOR = "savings_indicator";
const SESSIONS_GROUP = "sessions_group";
const SESSIONS_TYPE = "sessions_type";
const SETTINGS_SOLAR_ADJUSTED = "settings_solar_adjusted";
const SETTINGS_PRICE_ZOOM = "settings_price_zoom";
const SETTINGS_HIDE_FEEDIN = "settings_hide_feedin";
const LAST_BATTERY_SMART_COST_LIMIT = "last_battery_smart_cost_limit";
const LAST_TARGET_TIME = "last_target_time";
const LAST_SOC_GOAL = "last_soc_goal";
const LAST_ENERGY_GOAL = "last_energy_goal";
const CONFIG_CARD_HEIGHTS = "config_card_heights";
const LAST_ACKNOWLEDGED_VERSION = "last_acknowledged_version";

function read(key: string) {
  return window.localStorage[key];
}

function save(key: string) {
  return (value: string | null | undefined) => {
    try {
      if (value) {
        window.localStorage[key] = value;
      } else {
        delete window.localStorage[key];
      }
    } catch (e) {
      console.error("unable to write to localstorage", { key, value, e });
    }
  };
}

function readBool(key: string) {
  return read(key) === "true";
}

function saveBool(key: string) {
  return (value: boolean) => {
    save(key)(value ? "true" : "false");
  };
}

function readNumber(key: string) {
  const value = read(key);
  return value ? parseFloat(value) : undefined;
}

function saveNumber(key: string) {
  return (value: number | undefined) => {
    save(key)(value ? value.toString() : null);
  };
}

function readArray(key: string) {
  const value = read(key);
  return value ? value.split(",") : [];
}

function saveArray(key: string) {
  return (value: string[]) => {
    save(key)(value.join(","));
  };
}

function readJSON(key: string) {
  const value = read(key);
  try {
    return value ? JSON.parse(value) : {};
  } catch (e) {
    console.error("unable to parse JSON from localStorage", { key, value, e });
    return {};
  }
}

function saveJSON(key: string) {
  return (value: object) => {
    try {
      save(key)(JSON.stringify(value));
    } catch (e) {
      console.error("unable to stringify JSON for localStorage", { key, value, e });
    }
  };
}

export interface LoadpointSettings {
  order?: number;
  visible?: boolean;
  info?: SessionInfoKey;
  lastSmartCostLimit?: number;
  lastSmartFeedInPriorityLimit?: number;
}

export interface Settings {
  locale: keyof typeof LOCALES | null;
  theme: THEME | null;
  unit: string;
  is12hFormat: boolean;
  energyflowDetails: boolean;
  energyflowCo2: boolean;
  energyflowPv: boolean;
  energyflowBattery: boolean;
  energyflowLoadpoints: boolean;
  energyflowConsumers: boolean;
  sessionColumns: string[];
  savingsPeriod: string;
  savingsRegion: string;
  savingsIndicator: string;
  sessionsGroup: string;
  sessionsType: string;
  solarAdjusted: boolean;
  priceZoom: boolean;
  hideFeedin: boolean;
  loadpoints: Record<string, LoadpointSettings>;
  lastBatterySmartCostLimit: number | undefined;
  lastTargetTime: string | null;
  lastSocGoal: number | undefined;
  lastEnergyGoal: number | undefined;
  cardHeights: Record<string, number>;
  lastAcknowledgedVersion: string | undefined;
}

const settings: Settings = reactive({
  locale: read(SETTINGS_LOCALE),
  theme: read(SETTINGS_THEME),
  unit: read(SETTINGS_UNIT),
  is12hFormat: readBool(SETTINGS_12H_FORMAT),
  energyflowDetails: readBool(SETTINGS_ENERGYFLOW_DETAILS),
  energyflowCo2: readBool(SETTINGS_ENERGYFLOW_CO2),
  energyflowPv: readBool(SETTINGS_ENERGYFLOW_PV),
  energyflowBattery: readBool(SETTINGS_ENERGYFLOW_BATTERY),
  energyflowLoadpoints: readBool(SETTINGS_ENERGYFLOW_LOADPOINTS),
  energyflowConsumers: readBool(SETTINGS_ENERGYFLOW_CONSUMERS),
  sessionColumns: readArray(SESSION_COLUMNS),
  savingsPeriod: read(SAVINGS_PERIOD),
  savingsRegion: read(SAVINGS_REGION),
  savingsIndicator: read(SAVINGS_INDICATOR),
  sessionsGroup: read(SESSIONS_GROUP),
  sessionsType: read(SESSIONS_TYPE),
  solarAdjusted: false, //readBool(SETTINGS_SOLAR_ADJUSTED), # temporarily disable, https://github.com/evcc-io/evcc/issues/29165
  priceZoom: readBool(SETTINGS_PRICE_ZOOM),
  hideFeedin: readBool(SETTINGS_HIDE_FEEDIN),
  loadpoints: readJSON(LOADPOINTS),
  lastBatterySmartCostLimit: readNumber(LAST_BATTERY_SMART_COST_LIMIT),
  lastTargetTime: read(LAST_TARGET_TIME),
  lastSocGoal: readNumber(LAST_SOC_GOAL),
  lastEnergyGoal: readNumber(LAST_ENERGY_GOAL),
  cardHeights: readJSON(CONFIG_CARD_HEIGHTS),
  lastAcknowledgedVersion: read(LAST_ACKNOWLEDGED_VERSION),
});

watch(() => settings.locale, save(SETTINGS_LOCALE));
watch(() => settings.theme, save(SETTINGS_THEME));
watch(() => settings.unit, save(SETTINGS_UNIT));
watch(() => settings.is12hFormat, saveBool(SETTINGS_12H_FORMAT));
watch(() => settings.energyflowDetails, saveBool(SETTINGS_ENERGYFLOW_DETAILS));
watch(() => settings.energyflowCo2, saveBool(SETTINGS_ENERGYFLOW_CO2));
watch(() => settings.energyflowPv, saveBool(SETTINGS_ENERGYFLOW_PV));
watch(() => settings.energyflowBattery, saveBool(SETTINGS_ENERGYFLOW_BATTERY));
watch(() => settings.energyflowLoadpoints, saveBool(SETTINGS_ENERGYFLOW_LOADPOINTS));
watch(() => settings.energyflowConsumers, saveBool(SETTINGS_ENERGYFLOW_CONSUMERS));
watch(() => settings.sessionColumns as string[], saveArray(SESSION_COLUMNS));
watch(() => settings.savingsPeriod, save(SAVINGS_PERIOD));
watch(() => settings.savingsRegion, save(SAVINGS_REGION));
watch(() => settings.savingsIndicator, save(SAVINGS_INDICATOR));
watch(() => settings.sessionsGroup, save(SESSIONS_GROUP));
watch(() => settings.sessionsType, save(SESSIONS_TYPE));
watch(() => settings.solarAdjusted, saveBool(SETTINGS_SOLAR_ADJUSTED));
watch(() => settings.priceZoom, saveBool(SETTINGS_PRICE_ZOOM));
watch(() => settings.hideFeedin, saveBool(SETTINGS_HIDE_FEEDIN));
watch(() => settings.loadpoints, saveJSON(LOADPOINTS), { deep: true });
watch(() => settings.lastBatterySmartCostLimit, saveNumber(LAST_BATTERY_SMART_COST_LIMIT));
watch(() => settings.lastTargetTime, save(LAST_TARGET_TIME));
watch(() => settings.lastSocGoal, saveNumber(LAST_SOC_GOAL));
watch(() => settings.lastEnergyGoal, saveNumber(LAST_ENERGY_GOAL));
watch(() => settings.cardHeights, saveJSON(CONFIG_CARD_HEIGHTS), { deep: true });
watch(() => settings.lastAcknowledgedVersion, save(LAST_ACKNOWLEDGED_VERSION));

export default settings;

// MIGRATIONS

// Convert old comma-separated session_info to new loadpoints structure
// TODO: remove in later release
const SESSION_INFO = "session_info";
const oldSessionInfo = read(SESSION_INFO);
if (oldSessionInfo && Object.keys(settings.loadpoints).length === 0) {
  const sessionInfoArray = oldSessionInfo.split(",");
  sessionInfoArray.forEach((info: string, index: number) => {
    if (info.trim()) {
      const loadpointId = `${index + 1}`;
      if (!settings.loadpoints[loadpointId]) {
        settings.loadpoints[loadpointId] = {};
      }
      settings.loadpoints[loadpointId].info = info.trim() as SessionInfoKey;
    }
  });
  // Remove the old session_info key
  delete window.localStorage[SESSION_INFO];
}