@etsoo/shared 1.0.90 → 1.0.91

package/__tests__/WindowStorageTests.ts

@@ -1,7 +1,12 @@
 import { WindowStorage } from '../src/storage/WindowStorage';
 
 // Arrange
-const storage = new WindowStorage([], (_field, data, _index) => data);
+localStorage.setItem('test', 'test');
+localStorage.setItem('a', 'a');
+const storage = new WindowStorage(['test', 'a'], (field, data, index) => {
+    if (index === 0 && field === 'test') return null;
+    return data;
+});
 
 test('Tests for getInstanceCount', () => {
     expect(storage.getInstanceCount()).toBe(0);
@@ -14,3 +19,17 @@ test('Tests for updateInstanceCount / getInstanceCount', () => {
     // Always make sure it starts with 0
     expect(storage.getInstanceCount()).toBe(0);
 });
+
+test('Tests for getData', () => {
+    expect(storage.getData('test')).toBeUndefined();
+    expect(storage.getPersistedData('test')).toBe('test');
+
+    expect(storage.getData('a')).toBe('a');
+    expect(storage.getPersistedData('a')).toBe('a');
+});
+
+test('Tests for setData', () => {
+    storage.setData('test', 'test2');
+    expect(storage.getData('test')).toBe('test2');
+    expect(storage.getPersistedData('test')).toBe('test2');
+});

package/lib/cjs/storage/IStorage.d.ts

@@ -9,29 +9,47 @@ export interface IStorage {
     /**
      * Get data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, persistance?: boolean): T | undefined;
+    getData<T>(key: string): T | undefined;
     /**
      * Get data with default value
      * @param key Key name
      * @param defaultValue Default value
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, defaultValue: T, persistance?: boolean): T;
+    getData<T>(key: string, defaultValue: T): T;
+    /**
+     * Get persisted data
+     * @param key Key name
+     */
+    getPersistedData<T>(key: string): T | undefined;
+    /**
+     * Get persisted data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getPersistedData<T>(key: string, defaultValue: T): T;
     /**
      * Get object data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getObject<T extends {}>(key: string, persistance?: boolean): T | undefined;
+    getObject<T extends {}>(key: string): T | undefined;
+    /**
+     * Get persisted object data
+     * @param key Key name
+     */
+    getPersistedObject<T extends {}>(key: string): T | undefined;
     /**
      * Set data
      * @param key Key name
      * @param data  Data, null for removal
-     * @param persistance Persist the data, false will stop persistance
      */
-    setData(key: string, data: unknown, persistance?: boolean): void;
+    setData(key: string, data: unknown): void;
+    /**
+     * Set persisted data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setPersistedData(key: string, data: unknown): void;
     /**
      * Get current instance count
      * @returns Current instance count

package/lib/cjs/storage/WindowStorage.d.ts

@@ -4,7 +4,7 @@ import { IStorage, IStorageInitCallback } from './IStorage';
  * https://developer.mozilla.org/en-US/docs/Web/API/Storage
  */
 export declare class WindowStorage implements IStorage {
-    private globalFields;
+    protected persistedFields: string[];
     /**
      * Instance count field name
      */
@@ -16,36 +16,54 @@ export declare class WindowStorage implements IStorage {
     get instanceIndex(): number;
     /**
      * Constructor
-     * @param globalFields Global fields
+     * @param persistedFields Persisted fields
      * @param callback Field and data callback
      */
-    constructor(globalFields: string[], callback: IStorageInitCallback);
+    constructor(persistedFields: string[], callback: IStorageInitCallback);
     /**
      * Get data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, persistance?: boolean): T | undefined;
+    getData<T>(key: string): T | undefined;
     /**
      * Get data with default value
      * @param key Key name
      * @param defaultValue Default value
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, defaultValue: T, persistance?: boolean): T;
+    getData<T>(key: string, defaultValue: T): T;
+    /**
+     * Get persisted data
+     * @param key Key name
+     */
+    getPersistedData<T>(key: string): T | undefined;
+    /**
+     * Get persisted data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getPersistedData<T>(key: string, defaultValue: T): T;
     /**
      * Get object data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getObject<T extends {}>(key: string, persistance?: boolean): T | undefined;
+    getObject<T extends {}>(key: string): T | undefined;
+    /**
+     * Get persisted object data
+     * @param key Key name
+     */
+    getPersistedObject<T extends {}>(key: string): T | undefined;
     /**
      * Set data
      * @param key Key name
      * @param data  Data, null for removal
-     * @param persistance To the persisted data, false will stop persistance
      */
-    setData(key: string, data: unknown, persistance?: boolean): void;
+    setData(key: string, data: unknown): void;
+    /**
+     * Set persisted data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setPersistedData(key: string, data: unknown): void;
     /**
      * Get current instance count
      * @returns Current instance count

package/lib/cjs/storage/WindowStorage.js

@@ -10,11 +10,11 @@ const Utils_1 = require("../Utils");
 class WindowStorage {
     /**
      * Constructor
-     * @param globalFields Global fields
+     * @param persistedFields Persisted fields
      * @param callback Field and data callback
      */
-    constructor(globalFields, callback) {
-        this.globalFields = globalFields;
+    constructor(persistedFields, callback) {
+        this.persistedFields = persistedFields;
         /**
          * Instance count field name
          */
@@ -22,7 +22,7 @@ class WindowStorage {
         // Init instance index
         this._instanceIndex = this.getInstanceCount();
         // Copy global fields to session storage
-        globalFields.forEach((field) => {
+        persistedFields.forEach((field) => {
             const data = callback(field, localStorage.getItem(field), this._instanceIndex);
             if (data == null)
                 sessionStorage.removeItem(field);
@@ -40,13 +40,24 @@ class WindowStorage {
      * Get data
      * @param key Key name
      * @param defaultValue Default value
-     * @param persistance From the persisted data
      */
-    getData(key, defaultValue, persistance) {
+    getData(key, defaultValue) {
         // Get storage
-        const data = persistance
-            ? localStorage.getItem(key)
-            : sessionStorage.getItem(key);
+        const data = sessionStorage.getItem(key);
+        // No default value
+        if (defaultValue == null)
+            return Utils_1.Utils.parseString(data);
+        // Return
+        return Utils_1.Utils.parseString(data, defaultValue);
+    }
+    /**
+     * Get persisted data
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getPersistedData(key, defaultValue) {
+        // Get storage
+        const data = localStorage.getItem(key);
         // No default value
         if (defaultValue == null)
             return Utils_1.Utils.parseString(data);
@@ -56,13 +67,21 @@ class WindowStorage {
     /**
      * Get object data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getObject(key, persistance) {
+    getObject(key) {
         // Get storage
-        const data = persistance
-            ? localStorage.getItem(key)
-            : sessionStorage.getItem(key);
+        const data = sessionStorage.getItem(key);
+        if (data == null)
+            return undefined;
+        return JSON.parse(data);
+    }
+    /**
+     * Get persisted object data
+     * @param key Key name
+     */
+    getPersistedObject(key) {
+        // Get storage
+        const data = localStorage.getItem(key);
         if (data == null)
             return undefined;
         return JSON.parse(data);
@@ -71,24 +90,27 @@ class WindowStorage {
      * Set data
      * @param key Key name
      * @param data  Data, null for removal
-     * @param persistance To the persisted data, false will stop persistance
      */
-    setData(key, data, persistance) {
-        if (persistance) {
-            StorageUtils_1.StorageUtils.setLocalData(key, data);
-            return;
-        }
+    setData(key, data) {
         StorageUtils_1.StorageUtils.setSessionData(key, data);
-        if (persistance !== false && this.globalFields.includes(key)) {
-            StorageUtils_1.StorageUtils.setLocalData(key, data);
+        if (this.persistedFields.includes(key)) {
+            this.setPersistedData(key, data);
         }
     }
+    /**
+     * Set persisted data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setPersistedData(key, data) {
+        StorageUtils_1.StorageUtils.setLocalData(key, data);
+    }
     /**
      * Get current instance count
      * @returns Current instance count
      */
     getInstanceCount() {
-        const count = this.getData(this.instanceCountField, 0, true);
+        const count = this.getPersistedData(this.instanceCountField, 0);
         // Make sure starting from 0
         if (count < 0)
             return 0;
@@ -101,7 +123,7 @@ class WindowStorage {
      */
     updateInstanceCount(removed) {
         const count = this.getInstanceCount() + (removed ? -1 : 1);
-        this.setData(this.instanceCountField, count, true);
+        this.setPersistedData(this.instanceCountField, count);
         return count;
     }
 }

package/lib/mjs/storage/IStorage.d.ts

@@ -9,29 +9,47 @@ export interface IStorage {
     /**
      * Get data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, persistance?: boolean): T | undefined;
+    getData<T>(key: string): T | undefined;
     /**
      * Get data with default value
      * @param key Key name
      * @param defaultValue Default value
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, defaultValue: T, persistance?: boolean): T;
+    getData<T>(key: string, defaultValue: T): T;
+    /**
+     * Get persisted data
+     * @param key Key name
+     */
+    getPersistedData<T>(key: string): T | undefined;
+    /**
+     * Get persisted data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getPersistedData<T>(key: string, defaultValue: T): T;
     /**
      * Get object data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getObject<T extends {}>(key: string, persistance?: boolean): T | undefined;
+    getObject<T extends {}>(key: string): T | undefined;
+    /**
+     * Get persisted object data
+     * @param key Key name
+     */
+    getPersistedObject<T extends {}>(key: string): T | undefined;
     /**
      * Set data
      * @param key Key name
      * @param data  Data, null for removal
-     * @param persistance Persist the data, false will stop persistance
      */
-    setData(key: string, data: unknown, persistance?: boolean): void;
+    setData(key: string, data: unknown): void;
+    /**
+     * Set persisted data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setPersistedData(key: string, data: unknown): void;
     /**
      * Get current instance count
      * @returns Current instance count

package/lib/mjs/storage/WindowStorage.d.ts

@@ -4,7 +4,7 @@ import { IStorage, IStorageInitCallback } from './IStorage';
  * https://developer.mozilla.org/en-US/docs/Web/API/Storage
  */
 export declare class WindowStorage implements IStorage {
-    private globalFields;
+    protected persistedFields: string[];
     /**
      * Instance count field name
      */
@@ -16,36 +16,54 @@ export declare class WindowStorage implements IStorage {
     get instanceIndex(): number;
     /**
      * Constructor
-     * @param globalFields Global fields
+     * @param persistedFields Persisted fields
      * @param callback Field and data callback
      */
-    constructor(globalFields: string[], callback: IStorageInitCallback);
+    constructor(persistedFields: string[], callback: IStorageInitCallback);
     /**
      * Get data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, persistance?: boolean): T | undefined;
+    getData<T>(key: string): T | undefined;
     /**
      * Get data with default value
      * @param key Key name
      * @param defaultValue Default value
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, defaultValue: T, persistance?: boolean): T;
+    getData<T>(key: string, defaultValue: T): T;
+    /**
+     * Get persisted data
+     * @param key Key name
+     */
+    getPersistedData<T>(key: string): T | undefined;
+    /**
+     * Get persisted data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getPersistedData<T>(key: string, defaultValue: T): T;
     /**
      * Get object data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getObject<T extends {}>(key: string, persistance?: boolean): T | undefined;
+    getObject<T extends {}>(key: string): T | undefined;
+    /**
+     * Get persisted object data
+     * @param key Key name
+     */
+    getPersistedObject<T extends {}>(key: string): T | undefined;
     /**
      * Set data
      * @param key Key name
      * @param data  Data, null for removal
-     * @param persistance To the persisted data, false will stop persistance
      */
-    setData(key: string, data: unknown, persistance?: boolean): void;
+    setData(key: string, data: unknown): void;
+    /**
+     * Set persisted data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setPersistedData(key: string, data: unknown): void;
     /**
      * Get current instance count
      * @returns Current instance count

package/lib/mjs/storage/WindowStorage.js

@@ -7,11 +7,11 @@ import { Utils } from '../Utils';
 export class WindowStorage {
     /**
      * Constructor
-     * @param globalFields Global fields
+     * @param persistedFields Persisted fields
      * @param callback Field and data callback
      */
-    constructor(globalFields, callback) {
-        this.globalFields = globalFields;
+    constructor(persistedFields, callback) {
+        this.persistedFields = persistedFields;
         /**
          * Instance count field name
          */
@@ -19,7 +19,7 @@ export class WindowStorage {
         // Init instance index
         this._instanceIndex = this.getInstanceCount();
         // Copy global fields to session storage
-        globalFields.forEach((field) => {
+        persistedFields.forEach((field) => {
             const data = callback(field, localStorage.getItem(field), this._instanceIndex);
             if (data == null)
                 sessionStorage.removeItem(field);
@@ -37,13 +37,24 @@ export class WindowStorage {
      * Get data
      * @param key Key name
      * @param defaultValue Default value
-     * @param persistance From the persisted data
      */
-    getData(key, defaultValue, persistance) {
+    getData(key, defaultValue) {
         // Get storage
-        const data = persistance
-            ? localStorage.getItem(key)
-            : sessionStorage.getItem(key);
+        const data = sessionStorage.getItem(key);
+        // No default value
+        if (defaultValue == null)
+            return Utils.parseString(data);
+        // Return
+        return Utils.parseString(data, defaultValue);
+    }
+    /**
+     * Get persisted data
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getPersistedData(key, defaultValue) {
+        // Get storage
+        const data = localStorage.getItem(key);
         // No default value
         if (defaultValue == null)
             return Utils.parseString(data);
@@ -53,13 +64,21 @@ export class WindowStorage {
     /**
      * Get object data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getObject(key, persistance) {
+    getObject(key) {
         // Get storage
-        const data = persistance
-            ? localStorage.getItem(key)
-            : sessionStorage.getItem(key);
+        const data = sessionStorage.getItem(key);
+        if (data == null)
+            return undefined;
+        return JSON.parse(data);
+    }
+    /**
+     * Get persisted object data
+     * @param key Key name
+     */
+    getPersistedObject(key) {
+        // Get storage
+        const data = localStorage.getItem(key);
         if (data == null)
             return undefined;
         return JSON.parse(data);
@@ -68,24 +87,27 @@ export class WindowStorage {
      * Set data
      * @param key Key name
      * @param data  Data, null for removal
-     * @param persistance To the persisted data, false will stop persistance
      */
-    setData(key, data, persistance) {
-        if (persistance) {
-            StorageUtils.setLocalData(key, data);
-            return;
-        }
+    setData(key, data) {
         StorageUtils.setSessionData(key, data);
-        if (persistance !== false && this.globalFields.includes(key)) {
-            StorageUtils.setLocalData(key, data);
+        if (this.persistedFields.includes(key)) {
+            this.setPersistedData(key, data);
         }
     }
+    /**
+     * Set persisted data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setPersistedData(key, data) {
+        StorageUtils.setLocalData(key, data);
+    }
     /**
      * Get current instance count
      * @returns Current instance count
      */
     getInstanceCount() {
-        const count = this.getData(this.instanceCountField, 0, true);
+        const count = this.getPersistedData(this.instanceCountField, 0);
         // Make sure starting from 0
         if (count < 0)
             return 0;
@@ -98,7 +120,7 @@ export class WindowStorage {
      */
     updateInstanceCount(removed) {
         const count = this.getInstanceCount() + (removed ? -1 : 1);
-        this.setData(this.instanceCountField, count, true);
+        this.setPersistedData(this.instanceCountField, count);
         return count;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.0.90",
+    "version": "1.0.91",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

package/src/storage/IStorage.ts

@@ -10,32 +10,54 @@ export interface IStorage {
     /**
      * Get data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, persistance?: boolean): T | undefined;
+    getData<T>(key: string): T | undefined;
 
     /**
      * Get data with default value
      * @param key Key name
      * @param defaultValue Default value
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, defaultValue: T, persistance?: boolean): T;
+    getData<T>(key: string, defaultValue: T): T;
+
+    /**
+     * Get persisted data
+     * @param key Key name
+     */
+    getPersistedData<T>(key: string): T | undefined;
+
+    /**
+     * Get persisted data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getPersistedData<T>(key: string, defaultValue: T): T;
 
     /**
      * Get object data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getObject<T extends {}>(key: string, persistance?: boolean): T | undefined;
+    getObject<T extends {}>(key: string): T | undefined;
+
+    /**
+     * Get persisted object data
+     * @param key Key name
+     */
+    getPersistedObject<T extends {}>(key: string): T | undefined;
 
     /**
      * Set data
      * @param key Key name
      * @param data  Data, null for removal
-     * @param persistance Persist the data, false will stop persistance
      */
-    setData(key: string, data: unknown, persistance?: boolean): void;
+    setData(key: string, data: unknown): void;
+
+    /**
+     * Set persisted data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setPersistedData(key: string, data: unknown): void;
 
     /**
      * Get current instance count

package/src/storage/WindowStorage.ts

@@ -22,18 +22,18 @@ export class WindowStorage implements IStorage {
 
     /**
      * Constructor
-     * @param globalFields Global fields
+     * @param persistedFields Persisted fields
      * @param callback Field and data callback
      */
     constructor(
-        private globalFields: string[],
+        protected persistedFields: string[],
         callback: IStorageInitCallback
     ) {
         // Init instance index
         this._instanceIndex = this.getInstanceCount();
 
         // Copy global fields to session storage
-        globalFields.forEach((field) => {
+        persistedFields.forEach((field) => {
             const data = callback(
                 field,
                 localStorage.getItem(field),
@@ -47,33 +47,53 @@ export class WindowStorage implements IStorage {
     /**
      * Get data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, persistance?: boolean): T | undefined;
+    getData<T>(key: string): T | undefined;
 
     /**
      * Get data with default value
      * @param key Key name
      * @param defaultValue Default value
-     * @param persistance From the persisted data
      */
-    getData<T>(key: string, defaultValue: T, persistance?: boolean): T;
+    getData<T>(key: string, defaultValue: T): T;
 
     /**
      * Get data
      * @param key Key name
      * @param defaultValue Default value
-     * @param persistance From the persisted data
      */
-    getData<T>(
-        key: string,
-        defaultValue?: T,
-        persistance?: boolean
-    ): T | undefined {
+    getData<T>(key: string, defaultValue?: T): T | undefined {
         // Get storage
-        const data = persistance
-            ? localStorage.getItem(key)
-            : sessionStorage.getItem(key);
+        const data = sessionStorage.getItem(key);
+
+        // No default value
+        if (defaultValue == null) return Utils.parseString<T>(data);
+
+        // Return
+        return Utils.parseString<T>(data, defaultValue);
+    }
+
+    /**
+     * Get persisted data
+     * @param key Key name
+     */
+    getPersistedData<T>(key: string): T | undefined;
+
+    /**
+     * Get persisted data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getPersistedData<T>(key: string, defaultValue: T): T;
+
+    /**
+     * Get persisted data
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getPersistedData<T>(key: string, defaultValue?: T): T | undefined {
+        // Get storage
+        const data = localStorage.getItem(key);
 
         // No default value
         if (defaultValue == null) return Utils.parseString<T>(data);
@@ -85,13 +105,23 @@ export class WindowStorage implements IStorage {
     /**
      * Get object data
      * @param key Key name
-     * @param persistance From the persisted data
      */
-    getObject<T extends {}>(key: string, persistance?: boolean) {
+    getObject<T extends {}>(key: string) {
+        // Get storage
+        const data = sessionStorage.getItem(key);
+
+        if (data == null) return undefined;
+
+        return <T>JSON.parse(data);
+    }
+
+    /**
+     * Get persisted object data
+     * @param key Key name
+     */
+    getPersistedObject<T extends {}>(key: string) {
         // Get storage
-        const data = persistance
-            ? localStorage.getItem(key)
-            : sessionStorage.getItem(key);
+        const data = localStorage.getItem(key);
 
         if (data == null) return undefined;
 
@@ -102,26 +132,29 @@ export class WindowStorage implements IStorage {
      * Set data
      * @param key Key name
      * @param data  Data, null for removal
-     * @param persistance To the persisted data, false will stop persistance
      */
-    setData(key: string, data: unknown, persistance?: boolean) {
-        if (persistance) {
-            StorageUtils.setLocalData(key, data);
-            return;
-        }
-
+    setData(key: string, data: unknown) {
         StorageUtils.setSessionData(key, data);
-        if (persistance !== false && this.globalFields.includes(key)) {
-            StorageUtils.setLocalData(key, data);
+        if (this.persistedFields.includes(key)) {
+            this.setPersistedData(key, data);
         }
     }
 
+    /**
+     * Set persisted data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setPersistedData(key: string, data: unknown) {
+        StorageUtils.setLocalData(key, data);
+    }
+
     /**
      * Get current instance count
      * @returns Current instance count
      */
     getInstanceCount() {
-        const count = this.getData(this.instanceCountField, 0, true);
+        const count = this.getPersistedData(this.instanceCountField, 0);
         // Make sure starting from 0
         if (count < 0) return 0;
         return count;
@@ -134,7 +167,7 @@ export class WindowStorage implements IStorage {
      */
     updateInstanceCount(removed: boolean) {
         const count = this.getInstanceCount() + (removed ? -1 : 1);
-        this.setData(this.instanceCountField, count, true);
+        this.setPersistedData(this.instanceCountField, count);
         return count;
     }
 }