CT/src/Model/storageModel.ts

// this file is responsible for reading and writing persistent data; all storage shall be handled by this file.

import { parse, stringify } from "./Utility/utility";

import { DATA_VERSION } from "./Utility/typeSafety";

const PATH_COMPONENT_SEPARATOR = "\\";

export default class StorageModel {
  storageEntryTree: StorageEntry = {};

  // basic
  store = (pathComponents: string[], value: string): void => {
    const key: string = StorageModel.pathComponentsToKey(...pathComponents);
    localStorage.setItem(key, value);
    this.updateTree(...pathComponents);
  };

  restore = (pathComponents: string[]): string | null => {
    const key: string = StorageModel.pathComponentsToKey(...pathComponents);
    return localStorage.getItem(key);
  };

  remove = (pathComponents: string[]): void => {
    const key: string = StorageModel.pathComponentsToKey(...pathComponents);
    localStorage.removeItem(key);
  };

  list = (pathComponents: string[]): string[] => {
    let currentParent: StorageEntry = this.storageEntryTree;
    for (const component of pathComponents) {
      const nextParent: StorageEntry | undefined = currentParent[component];
      if (nextParent == undefined) return [];
      currentParent = nextParent;
    }

    return [...Object.keys(currentParent)];
  };

  // stringifiable
  storeStringifiable = (pathComponents: string[], value: any): void => {
    const valueString: string = stringify(value);
    this.store(pathComponents, valueString);
  };

  restoreStringifiable = (pathComponents: string[]): any | null => {
    const valueString: string | null = this.restore(pathComponents);
    if (!valueString) return null;

    return parse(valueString);
  };

  // init
  constructor() {
    for (const key of Object.keys(localStorage)) {
      const components: string[] = StorageModel.keyToPathComponents(key);
      this.updateTree(...components);
    }
  }

  // utility
  updateTree = (...pathComponents: string[]) => {
    let currentParent: StorageEntry = this.storageEntryTree;
    for (const pathPart of pathComponents) {
      if (!currentParent[pathPart]) {
        currentParent[pathPart] = {};
      }

      currentParent = currentParent[pathPart];
    }
  };

  static pathComponentsToKey = (...pathComponents: string[]): string => {
    return pathComponents.join(PATH_COMPONENT_SEPARATOR);
  };

  static keyToPathComponents = (key: string): string[] => {
    return key.split(PATH_COMPONENT_SEPARATOR);
  };

  static join = (...items: string[]): string => {
    let allComponents: string[] = [];
    for (const item of items) {
      const parts = this.keyToPathComponents(item);
      allComponents.push(...parts);
    }
    return StorageModel.pathComponentsToKey(...allComponents);
  };
}

// types
export type StorageEntry = { [key: string]: StorageEntry };

// keys
export const storageKeys = {
  // connection
  socketAddress: [DATA_VERSION, "connection", "socket-address"],

  // settings
  username: [DATA_VERSION, "settings", "user-name"],
  firstDayOfWeek: [DATA_VERSION, "settings", "first-day-of-week"],

  // history
  previousAddresses: [DATA_VERSION, "history", "previous-addresses"],
  previousObjectCategories: [DATA_VERSION, "history", "object-categories"],
  previousObjectStatuses: [DATA_VERSION, "history", "object-statuses"],
  previousObjectFilters: [DATA_VERSION, "history", "object-filters"],

  // chat etc
  chatInfo: (id: string) => [DATA_VERSION, "chat", id, "info"],
  chatMessages: (id: string) => [DATA_VERSION, "chat", id, "messages"],
  chatObjects: (id: string) => [DATA_VERSION, "chat", id, "objects"],
  chatOutbox: (id: string) => [DATA_VERSION, "chat", id, "outbox"],
};