feat(WebStorageUtility): hold storage data inside the class, add clear() and forEach() methods, introduce LocalStorageUtility and SessionStorageUtility

Author: DanielKucal

src/config/config.helper.ts

@@ -1,13 +1,14 @@
 import { WebStorageUtilityClass } from '../utility/webstorage-utility.class';
 
 export class ConfigHelper {
-    protected static _webStorageUtility: WebStorageUtilityClass = new WebStorageUtilityClass('NGX-STORE_');
+    protected static _webStorageUtility: WebStorageUtilityClass =
+        new WebStorageUtilityClass(localStorage, 'NGX-STORE_');
 
     public static getItem(key: string): any {
-        return this._webStorageUtility.get(localStorage, key);
+        return this._webStorageUtility.get(key);
     }
 
     public static setItem(key: string, item: any): any {
-        return this._webStorageUtility.set(localStorage, key, item);
+        return this._webStorageUtility.set(key, item);
     }
 }

src/decorator/webstorage.ts

@@ -1,20 +1,21 @@
-import { WebStorageUtility } from '../utility';
+import { localStorageUtility, sessionStorageUtility } from '../utility';
 import { LocalStorageService, SessionStorageService, WebStorageServiceInterface } from '../service/webstorage.service';
 import * as isEmpty from 'is-empty';
 import { Config } from '../config';
+import { WebStorageUtilityClass } from '../utility/webstorage-utility.class';
 
 export function LocalStorage(key?: string) {
-    return WebStorage(localStorage, LocalStorageService, key);
+    return WebStorage(localStorageUtility, LocalStorageService, key);
 }
 
 export function SessionStorage(key?: string) {
-    return WebStorage(sessionStorage, SessionStorageService, key);
+    return WebStorage(sessionStorageUtility, SessionStorageService, key);
 }
 
 // initialization cache
 let cache: {[name: string]: boolean} = {};
 
-function WebStorage(webStorage: Storage, service: WebStorageServiceInterface, key: string) {
+function WebStorage(webStorageUtility: WebStorageUtilityClass, service: WebStorageServiceInterface, key: string) {
     return (target: any, propertyName: string): void => {
         key = key || propertyName;
 
@@ -28,7 +29,8 @@ function WebStorage(webStorage: Storage, service: WebStorageServiceInterface, ke
             };
         }
 
-        let proxy = WebStorageUtility.get(webStorage, key);
+        // let proxy = WebStorageUtility.get(webStorageUtility, key);
+        let proxy = webStorageUtility.get(key);
         service.keys.push(key);
 
         Object.defineProperty(target, propertyName, {
@@ -39,11 +41,12 @@ function WebStorage(webStorage: Storage, service: WebStorageServiceInterface, ke
                 if (!cache[key]) { // first setter handle
                     if (isEmpty(proxy)) {
                         // if no value in localStorage, set it to initializer
-                        proxy = WebStorageUtility.set(webStorage, key, value);
+                        // proxy = WebStorageUtility.set(webStorage, key, value);
+                        proxy = webStorageUtility.set(key, value);
                     }
                     cache[key] = true;
                 } else { // if there is no value in localStorage, set it to initializer
-                    proxy = WebStorageUtility.set(webStorage, key, value);
+                    proxy = webStorageUtility.set(key, value);
                 }
 
                 // Object mutations below
@@ -52,7 +55,7 @@ function WebStorage(webStorage: Storage, service: WebStorageServiceInterface, ke
                 // manual method for force save
                 if (proxy instanceof Object) {
                     proxy.save = function () {
-                        WebStorageUtility.set(webStorage, key, proxy);
+                        webStorageUtility.set(key, proxy);
                     };
                 }
 
@@ -65,7 +68,7 @@ function WebStorage(webStorage: Storage, service: WebStorageServiceInterface, ke
                     for (let method of methodsToOverwrite) {
                         proxy[method] = function(value) {
                             let result = Array.prototype[method].apply(proxy, arguments);
-                            WebStorageUtility.set(webStorage, key, proxy);
+                            webStorageUtility.set(key, proxy);
                             return result;
                         }
                     }

src/index.ts

@@ -3,7 +3,6 @@ import { LocalStorageService, SessionStorageService } from './service/webstorage
 
 export { LocalStorage, SessionStorage } from './decorator/webstorage'
 export { WebStorageService, LocalStorageService, SessionStorageService } from './service/webstorage.service';
-export { WebStorageUtility } from './utility';
 export { WebStorageConfigInterface, WEBSTORAGE_CONFIG } from './config';
 export declare class Webstorable {
     save(): void;

src/service/webstorage.service.ts

@@ -1,7 +1,8 @@
 import { Injectable } from '@angular/core';
 import { ClearType, Config } from '../config';
-import { WebStorageUtility } from '../utility';
 import { WebStorageConfigInterface } from '../config/config.interface';
+import { WebStorageUtilityClass } from '../utility/webstorage-utility.class';
+import { localStorageUtility, sessionStorageUtility } from '../utility';
 
 export interface WebStorageServiceInterface {
     keys: Array<string>;
@@ -18,7 +19,11 @@ export interface WebStorageServiceInterface {
 export abstract class WebStorageService {
     public static keys: Array<string>;
 
-    constructor(protected storage: Storage) {}
+    protected _webStorageUtility: WebStorageUtilityClass;
+
+    public constructor(protected webStorageUtility: WebStorageUtilityClass) {
+        this._webStorageUtility = webStorageUtility;
+    }
 
     /**
      * Gets keys from child class
@@ -33,15 +38,16 @@ export abstract class WebStorageService {
     }
 
     public get(key: string): any {
-        return WebStorageUtility.get(this.storage, key);
+        return this._webStorageUtility.get(key);
     }
 
     public set(key: string, value: any): void {
-        WebStorageUtility.set(this.storage, key, value);
+        return this._webStorageUtility.set(key, value);
     }
 
+    // TODO return true if item existed and false otherwise (?)
     public remove(key: string): void {
-        WebStorageUtility.remove(this.storage, key);
+        return this._webStorageUtility.remove(key);
     }
 
     /**
@@ -53,17 +59,17 @@ export abstract class WebStorageService {
         clearType = clearType || Config.clearType;
         if (clearType === 'decorators') {
             for (let key of this.keys) {
-                this.storage.removeItem(key);
+                this._webStorageUtility.remove(key);
             }
         } else if (clearType === 'prefix') {
             prefix = prefix || Config.prefix;
-            for (let key in this.storage) {
-                if (this.storage.getItem(key).startsWith(prefix)) {
-                    this.storage.removeItem(key);
+            this._webStorageUtility.forEach((key) => {
+                if (key.startsWith(prefix)) {
+                    this._webStorageUtility.remove(key);
                 }
-            }
+            });
         } else if (clearType === 'all') {
-            this.storage.clear();
+            this._webStorageUtility.clear();
         }
     }
 }
@@ -73,7 +79,7 @@ export class LocalStorageService extends WebStorageService {
     public static keys: Array<string> = [];
 
     constructor() {
-        super(localStorage);
+        super(localStorageUtility);
     }
 }
 
@@ -82,6 +88,6 @@ export class SessionStorageService extends WebStorageService {
     public static keys: Array<string> = [];
 
     constructor() {
-        super(sessionStorage);
+        super(sessionStorageUtility);
     }
 }

src/utility/index.ts

@@ -1,4 +1,7 @@
 import { Config } from '../config';
 import { WebStorageUtilityClass } from './webstorage-utility.class';
 
-export const WebStorageUtility: WebStorageUtilityClass = new WebStorageUtilityClass(Config.prefix);
+export const localStorageUtility: WebStorageUtilityClass =
+    new WebStorageUtilityClass(localStorage, Config.prefix, Config.previousPrefix);
+export const sessionStorageUtility: WebStorageUtilityClass =
+    new WebStorageUtilityClass(sessionStorage, Config.prefix, Config.previousPrefix);

src/utility/webstorage-utility.class.ts

@@ -1,5 +1,6 @@
 export class WebStorageUtilityClass {
     protected _prefix: string = '';
+    protected _storage: Storage;
 
     public static getSettable(value: any): string {
         return typeof value === "string" ? value : JSON.stringify(value);
@@ -14,30 +15,40 @@ export class WebStorageUtilityClass {
         }
     }
 
-    public constructor(prefix: string) {
+    public constructor(storage: Storage, prefix: string, previousPrefix?: string) {
+        this._storage = storage;
         this._prefix = prefix;
     }
 
-
     public getStorageKey(key: string): string {
         return `${this._prefix}${key}`;
     }
 
-    public get(storage: Storage, key: string): any {
+    public get(key: string): any {
         let storageKey = this.getStorageKey(key);
-        let value = storage.getItem(storageKey);
+        let value = this._storage.getItem(storageKey);
         return WebStorageUtilityClass.getGettable(value);
     }
 
-    public set(storage: Storage, key: string, value: any): any {
+    public set(key: string, value: any): any {
         let storageKey = this.getStorageKey(key);
         let storable = WebStorageUtilityClass.getSettable(value);
-        storage.setItem(storageKey, storable);
+        this._storage.setItem(storageKey, storable);
         return value;
     }
 
-    public remove(storage: Storage, key: string): void {
+    public remove(key: string): void {
         let storageKey = this.getStorageKey(key);
-        storage.removeItem(storageKey);
+        this._storage.removeItem(storageKey);
+    }
+
+    public clear() {
+        this._storage.clear();
+    }
+
+    public forEach(func: Function) {
+        for (let key in this._storage) {
+            func(key, this._storage[key]);
+        }
     }
 }