All files / src storage.ts

100% Statements 67/67
100% Branches 34/34
100% Functions 20/20
100% Lines 59/59

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                2x         2x   1x 3x   2x                       6x 6x   6x   4x   1x         5x   5x 2x   2x           3x   3x                 8x   8x   7x       2x   2x   1x                     8x   8x 3x     8x   6x 6x   2x 2x                 29x       29x 29x             29x 29x           2x         1x 1x     6x   6x   5x       2x   2x   1x       29x           7x 2x               2x                       1x 1x     6x   6x   5x       2x   2x   1x       29x           3x 1x                                                                                    
export class RibbonStorage {
  /**
   * Here be dragons!
   *
   * If you need to remove a listener use {@link RibbonStorage.off}
   * to reset all listeners use {@link RibbonStorage.reset}
   * @private
   */
  static $listeners: RibbonStorage.Listeners = {
    change: [],
  };
 
  static {
    if ('window' in globalThis) {
      // Picks up localStorage changes from other tabs
      window.addEventListener('storage', (event) => {
        if (event.key === null) return;
 
        RibbonStorage.$emit('change', {
          type: event.storageArea === localStorage ? 'local' : 'session',
          key: event.key,
          value: event.newValue === null ? null : JSON.parse(event.newValue),
        });
      });
    }
  }
 
  static get<T>(storage: globalThis.Storage, key: string, defaultValue: T): T;
  static get<T>(storage: globalThis.Storage, key: string, defaultValue?: T): T | null;
  static get<T>(storage: globalThis.Storage, key: string, defaultValue?: T): T | null {
    try {
      const value = storage.getItem(key);
 
      if (!value) return defaultValue ?? null;
 
      return JSON.parse(value);
    } catch {
      return defaultValue ?? null;
    }
  }
 
  static set<T>(storage: globalThis.Storage, key: string, value: T): void {
    const type = storage === localStorage ? 'local' : 'session';
 
    if (value === undefined || value === null) {
      storage.removeItem(key);
 
      RibbonStorage.$emit('change', {
        type,
        key,
        value: null,
      });
    } else {
      storage.setItem(key, JSON.stringify(value));
 
      RibbonStorage.$emit('change', {
        type,
        key,
        value,
      });
    }
  }
 
  static on<K extends keyof RibbonStorage.Listeners>(key: K, listener: RibbonStorage.Listeners[K][number]): void {
    const index = RibbonStorage.$listeners[key].indexOf(listener);
 
    if (index !== -1) return;
 
    RibbonStorage.$listeners[key].push(listener);
  }
 
  static off<K extends keyof RibbonStorage.Listeners>(key: K, listener: RibbonStorage.Listeners[K][number]): void {
    const index = RibbonStorage.$listeners[key].indexOf(listener);
 
    if (index === -1) return;
 
    RibbonStorage.$listeners[key].splice(index, 1);
  }
 
  /**
   * Here be dragons! This should never be called externally!
   * @private
   */
  static $emit<K extends keyof RibbonStorage.Listeners>(
    key: K,
    ...args: Parameters<RibbonStorage.Listeners[K][number]>
  ): void {
    const [event] = args;
 
    for (const listener of RibbonStorage.$listeners[key]) {
      listener.apply(undefined, args);
    }
 
    switch (event.type) {
      case 'local':
        RibbonStorage.local.$emit(key, ...args);
        break;
      case 'session':
        RibbonStorage.session.$emit(key, ...args);
        break;
    }
  }
 
  /**
   * Resets RibbonStorage to a fresh state.
   * Clearing out listeners and what not.
   */
  static reset() {
    RibbonStorage.$listeners = {
      change: [],
    };
 
    RibbonStorage.local.reset();
    RibbonStorage.session.reset();
  }
 
  /**
   * Clears local and session storage.
   */
  static clear() {
    localStorage.clear();
    sessionStorage.clear();
  }
 
  /**
   * Shorthands for getting / setting from {@link localStorage}
   */
  static local: RibbonStorage.SubStorage = {
    $listeners: {
      change: [],
    },
 
    get: <T>(key: string, defaultValue?: T) => RibbonStorage.get(localStorage, key, defaultValue),
    set: <T>(key: string, value: T) => RibbonStorage.set(localStorage, key, value),
 
    on(key, listener) {
      const index = RibbonStorage.local.$listeners[key].indexOf(listener);
 
      if (index !== -1) return;
 
      RibbonStorage.local.$listeners[key].push(listener);
    },
 
    off(key, listener) {
      const index = RibbonStorage.local.$listeners[key].indexOf(listener);
 
      if (index === -1) return;
 
      RibbonStorage.local.$listeners[key].splice(index, 1);
    },
 
    reset() {
      RibbonStorage.local.$listeners = {
        change: [],
      };
    },
 
    $emit(key, ...args) {
      for (const listener of RibbonStorage.local.$listeners[key]) {
        listener.apply(undefined, args);
      }
    },
  };
 
  /**
   * Shorthands for getting / setting from {@link sessionStorage}
   */
  static session: RibbonStorage.SubStorage = {
    /**
     * Here be dragons!
     *
     * If you need to remove a listener use {@link RibbonStorage.off}
     * to reset all listeners use {@link RibbonStorage.reset}
     * @private
     */
    $listeners: {
      change: [],
    },
 
    get: <T>(key: string, defaultValue?: T) => RibbonStorage.get(sessionStorage, key, defaultValue),
    set: <T>(key: string, value: T) => RibbonStorage.set(sessionStorage, key, value),
 
    on(key, listener) {
      const index = RibbonStorage.session.$listeners[key].indexOf(listener);
 
      if (index !== -1) return;
 
      RibbonStorage.session.$listeners[key].push(listener);
    },
 
    off(key, listener) {
      const index = RibbonStorage.session.$listeners[key].indexOf(listener);
 
      if (index === -1) return;
 
      RibbonStorage.session.$listeners[key].splice(index, 1);
    },
 
    reset() {
      RibbonStorage.session.$listeners = {
        change: [],
      };
    },
 
    $emit(key, ...args) {
      for (const listener of RibbonStorage.session.$listeners[key]) {
        listener.apply(undefined, args);
      }
    },
  };
}
 
export namespace RibbonStorage {
  export type Listeners = {
    change: ((event: ChangeEvent) => void)[];
  };
 
  export type ChangeEvent = {
    type: 'local' | 'session';
    key: string;
 
    /**
     * This will always be the _parsed_ value!
     */
    value: any;
  };
 
  export type SubStorage = {
    $listeners: Listeners;
 
    on<K extends keyof Listeners>(key: K, listener: Listeners[K][number]): void;
    off<K extends keyof Listeners>(key: K, listener: Listeners[K][number]): void;
 
    get<T>(key: string, defaultValue: T): T;
    get<T>(key: string, defaultValue?: T): T | null;
    get<T>(key: string, defaultValue?: T): T | null;
 
    set<T>(key: string, value: T): void;
 
    reset(): void;
 
    /**
     * Here be dragons! This should never be called externally!
     * @private
     */
    $emit<K extends keyof Listeners>(key: K, ...args: Parameters<Listeners[K][number]>): void;
  };
}