@lesjoursfr/browser-tools/src/storage.ts

Some browser tools for events & DOM manipulation.

import Cookies from "js-cookie";

export enum KeyValueStorageTypes {
  localStorage = 1,
  cookies = 2,
}

export abstract class AbstractKeyValueStore {
  public readonly type: KeyValueStorageTypes;

  public constructor(type: KeyValueStorageTypes) {
    this.type = type;
  }

  /**
   * Return the key's value, or null if the key does not exist.
   * @param {string} key the name of the key you want to retrieve the value of
   * @returns {undefined|string } the value of the key or undefined if the key does not exist
   */
  public abstract getItem(key: string): undefined | string;

  /**
   * Add the key to the store, or update that key's value if it already exists.
   * @param {string} key the name of the key you want to create/update
   * @param {string} value the value you want to give the key you are creating/updating
   */
  public abstract setItem(key: string, value: string): void;

  /**
   * Remove the key from the store if it exists.
   * @param {string} key the name of the key you want to remove
   */
  public abstract removeItem(key: string): void;
}

export class LocalStorageKeyValueStore extends AbstractKeyValueStore {
  public constructor() {
    super(KeyValueStorageTypes.localStorage);
  }

  public getItem(key: string): undefined | string {
    const value = window.localStorage.getItem(key);
    return value === null ? undefined : value;
  }

  public setItem(key: string, value: string): void {
    window.localStorage.setItem(key, value);
  }

  public removeItem(key: string): void {
    window.localStorage.removeItem(key);
  }
}

export class CookiesKeyValueStore extends AbstractKeyValueStore {
  private readonly expires: number;

  public constructor(expires: number) {
    super(KeyValueStorageTypes.cookies);
    this.expires = expires;
  }

  public getItem(key: string): undefined | string {
    const value = Cookies.get(key);
    return value;
  }

  public setItem(key: string, value: string): void {
    Cookies.set(key, value, { expires: this.expires });
  }

  public removeItem(key: string): void {
    Cookies.remove(key);
  }
}

/**
 * Check if we can use the localStorage.
 * @returns {boolean}
 */
export function isLocalStorageAvailable(): boolean {
  const mod = "localStorageTest";
  try {
    localStorage.setItem(mod, mod);
    localStorage.removeItem(mod);
    return true;
  } catch (_err) {
    return false;
  }
}

let store: AbstractKeyValueStore | null = null;

/**
 * Get the default store for the browser.
 * The default store is the localStorage if it's available or the cookies.
 *
 * @param {number} expires the expires value for the cookies
 * @returns {AbstractKeyValueStore} the default store
 */
export function getDefaultKeyValueStore(expires: number = 365): AbstractKeyValueStore {
  if (store === null) {
    store = isLocalStorageAvailable() ? new LocalStorageKeyValueStore() : new CookiesKeyValueStore(expires);
  }

  return store;
}