feat: improve config

Author: DanielKucal

src/config/config.interface.ts

@@ -0,0 +1,6 @@
+export interface WebStorageConfigInterface {
+    prefix?: string;
+    clearType?: ClearType;
+    mutateObjects?: boolean;
+}
+export type ClearType = 'decorators' | 'prefix' | 'all';

src/config/config.ts

@@ -0,0 +1,19 @@
+import { WebStorageConfigInterface } from './config.interface';
+
+const DefaultConfig: WebStorageConfigInterface = {
+    prefix: 'angular2_ws', // TODO: change default to 'ngx_'
+    clearType: 'decorators', // TODO: change default to 'prefix'
+    mutateObjects: true
+};
+
+// TODO allow to set configuration in node-config (`config` on npm)
+// take configuration provided as a global variable
+declare const NGXSTORE_CONFIG: WebStorageConfigInterface;
+
+/**
+ * @deprecated define global variable `NGXSTORE_CONFIG` instead
+ */
+export const WEBSTORAGE_CONFIG = DefaultConfig;
+
+// merge default config, deprecated config and global config all together
+export const Config = Object.assign({}, DefaultConfig, WEBSTORAGE_CONFIG, NGXSTORE_CONFIG);

src/config/index.ts

@@ -0,0 +1,2 @@
+export * from './config';
+export * from './config.interface';

src/decorator/webstorage.ts

@@ -1,6 +1,7 @@
 import { WebStorageUtility } from '../utility/webstorage.utility';
 import { LocalStorageService, SessionStorageService, WebStorageServiceInterface } from '../service/webstorage.service';
 import * as isEmpty from 'is-empty';
+import { Config } from '../config';
 
 export function LocalStorage(key?: string) {
     return WebStorage(localStorage, LocalStorageService, key);
@@ -45,6 +46,9 @@ function WebStorage(webStorage: Storage, service: WebStorageServiceInterface, ke
                     proxy = WebStorageUtility.set(webStorage, key, value);
                 }
 
+                // Object mutations below
+                if (!Config.mutateObjects) return;
+
                 // manual method for force save
                 if (proxy instanceof Object) {
                     proxy.save = function () {

src/index.ts

@@ -4,13 +4,10 @@ import { LocalStorageService, SessionStorageService } from './service/webstorage
 export { LocalStorage, SessionStorage } from './decorator/webstorage'
 export { WebStorageService, LocalStorageService, SessionStorageService } from './service/webstorage.service';
 export { WebStorageUtility } from './utility/webstorage.utility';
+export { WebStorageConfigInterface, WEBSTORAGE_CONFIG } from './config';
 export declare class Webstorable {
     save(): void;
 }
-export type ClearType = 'decorators' | 'prefix' | 'all';
-export let WEBSTORAGE_CONFIG = {
-    prefix: 'angular2ws_'
-};
 
 @NgModule({
     providers: [

src/service/webstorage.service.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@angular/core';
+import { ClearType, Config } from '../config';
 import { WebStorageUtility } from '../utility/webstorage.utility';
-import { ClearType, WEBSTORAGE_CONFIG } from '../index';
 
 export interface WebStorageServiceInterface {
     keys: Array<string>;
@@ -29,15 +29,16 @@ export abstract class WebStorageService {
         WebStorageUtility.remove(this.storage, key);
     }
 
-    public clear(clearType: ClearType = 'decorators'): void {
+    public clear(clearType?: ClearType): void {
+        clearType = clearType || Config.clearType;
         let keys = (<WebStorageServiceInterface>this.constructor).keys; // get keys from child class
         if (clearType === 'decorators') {
             for (let key of keys) {
                 this.storage.removeItem(key);
             }
         } else if (clearType === 'prefix') {
             for (let key in this.storage) {
-                if (this.storage.getItem(key).startsWith(WEBSTORAGE_CONFIG.prefix)) {
+                if (this.storage.getItem(key).startsWith(Config.prefix)) {
                     this.storage.removeItem(key);
                 }
             }

src/utility/webstorage.utility.ts

@@ -1,8 +1,8 @@
-import {WEBSTORAGE_CONFIG} from '../index';
+import { Config } from '../config';
 
 export class WebStorageUtility {
     public static generateStorageKey(key: string): string {
-        return `${WEBSTORAGE_CONFIG.prefix}${key}`
+        return `${Config.prefix}${key}`;
     }
 
     public static get(storage: Storage, key: string): any {