@etsoo/shared 1.0.79 → 1.0.83

package/README.md

@@ -15,6 +15,9 @@ Using yarn:
 $ yarn add @etsoo/shared
 ```
 
+## storage
+Storage interface and browser storage implementation
+
 ## DataTypes
 Data type definitions and type safe functions
 

package/__tests__/StorageUtils.ts

@@ -7,7 +7,8 @@ test('Tests for all', () => {
     StorageUtils.setSessionData('number', 3.14);
     StorageUtils.setSessionData('test', { id: 123, name: 'test' });
 
-    expect(StorageUtils.getSessionData('string', '')).toBe('test');
+    expect(StorageUtils.getSessionData<string>('string')).toBe('test');
+    expect(StorageUtils.getSessionData('string1', '')).toBe('');
     expect(StorageUtils.getSessionData('boolean', false)).toBe(true);
     expect(StorageUtils.getSessionData('number', 0)).toBe(3.14);
     expect(StorageUtils.getSessionData('test', {})).toHaveProperty('id', 123);

package/__tests__/Utils.ts

@@ -101,8 +101,10 @@ test('Tests for objectUpdated', () => {
 
 test('Tests for parseString', () => {
     expect(Utils.parseString<string>('test')).toBe('test');
+    expect(Utils.parseString('test', '')).toBe('test');
     expect(Utils.parseString('true', false)).toBe(true);
     expect(Utils.parseString('', false)).toBeFalsy();
+    expect(Utils.parseString<boolean>('')).toBeUndefined();
     expect(Utils.parseString<number>(undefined)).toBeUndefined();
     expect(Utils.parseString('3.14', 0)).toBe(3.14);
     expect(Utils.parseString('2021/4/13', new Date())).toStrictEqual(

package/lib/cjs/StorageUtils.d.ts

@@ -15,12 +15,17 @@ export declare namespace StorageUtils {
      * @param data Data, null for removal
      */
     function setSessionData(key: string, data: unknown): void;
+    /**
+     * Get local storage data
+     * @param key Key name
+     */
+    function getLocalData<T>(key: string): T | undefined;
     /**
      * Get local storage data
      * @param key Key name
      * @param defaultValue Default value
      */
-    function getLocalData<T>(key: string, defaultValue?: T): T | undefined;
+    function getLocalData<T>(key: string, defaultValue: T): T;
     /**
      * Get local storage object data
      * @param key Key name
@@ -30,7 +35,13 @@ export declare namespace StorageUtils {
      * Get session storage data
      * @param key Key name
      */
-    function getSessionData<T>(key: string, defaultValue?: T): T | undefined;
+    function getSessionData<T>(key: string): T | undefined;
+    /**
+     * Get session storage data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    function getSessionData<T>(key: string, defaultValue: T): T;
     /**
      * Get session storage object data
      * @param key Key name

package/lib/cjs/StorageUtils.js

@@ -47,6 +47,9 @@ var StorageUtils;
     function getLocalData(key, defaultValue) {
         // Get storage
         const data = localStorage.getItem(key);
+        // No default value
+        if (defaultValue == null)
+            return Utils_1.Utils.parseString(data);
         // Return
         return Utils_1.Utils.parseString(data, defaultValue);
     }
@@ -66,10 +69,14 @@ var StorageUtils;
     /**
      * Get session storage data
      * @param key Key name
+     * @param defaultValue Default value
      */
     function getSessionData(key, defaultValue) {
         // Get storage
         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);
     }

package/lib/cjs/Utils.d.ts

@@ -134,6 +134,13 @@ export declare namespace Utils {
      * @returns Updated fields
      */
     function objectUpdated(objNew: {}, objPrev: {}, ignoreFields?: string[], strict?: number): string[];
+    /**
+     * Parse string (JSON) to specific type, no type conversion
+     * For type conversion, please use DataTypes.convert
+     * @param input Input string
+     * @returns Parsed value
+     */
+    function parseString<T>(input: string | undefined | null): T | undefined;
     /**
      * Parse string (JSON) to specific type, no type conversion
      * For type conversion, please use DataTypes.convert
@@ -141,7 +148,7 @@ export declare namespace Utils {
      * @param defaultValue Default value
      * @returns Parsed value
      */
-    function parseString<T>(input: string | undefined | null, defaultValue?: T): T | undefined;
+    function parseString<T>(input: string | undefined | null, defaultValue: T): T;
     /**
      * Remove non letters
      * @param input Input string

package/lib/cjs/Utils.js

@@ -268,6 +268,7 @@ var Utils;
     Utils.objectUpdated = objectUpdated;
     /**
      * Parse string (JSON) to specific type, no type conversion
+     * When return type depends on parameter value, uses function overloading, otherwise uses conditional type
      * For type conversion, please use DataTypes.convert
      * @param input Input string
      * @param defaultValue Default value

package/lib/cjs/index.d.ts

@@ -1,4 +1,6 @@
 export * from './types/FormData';
+export * from './storage/IStorage';
+export * from './storage/WindowStorage';
 export * from './DataTypes';
 export * from './DateUtils';
 export * from './DomUtils';

package/lib/cjs/index.js

@@ -11,6 +11,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types/FormData"), exports);
+__exportStar(require("./storage/IStorage"), exports);
+__exportStar(require("./storage/WindowStorage"), exports);
 __exportStar(require("./DataTypes"), exports);
 __exportStar(require("./DateUtils"), exports);
 __exportStar(require("./DomUtils"), exports);

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

@@ -0,0 +1,33 @@
+/**
+ * Storage interface
+ */
+export interface IStorage {
+    /**
+     * Get data
+     * @param key Key name
+     */
+    getData<T>(key: string): T | undefined;
+    /**
+     * Get data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getData<T>(key: string, defaultValue: T): T;
+    /**
+     * Get session storage object data
+     * @param key Key name
+     */
+    getObject<T extends {}>(key: string): T | undefined;
+    /**
+     * Set data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setData(key: string, data: unknown): void;
+}
+/**
+ * Storage constructor interface
+ */
+export interface IStorageConstructor {
+    new (globalFields: string[]): IStorage;
+}

package/lib/cjs/storage/IStorage.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,35 @@
+import { IStorage } from './IStorage';
+/**
+ * Window storage
+ * https://developer.mozilla.org/en-US/docs/Web/API/Storage
+ */
+export declare class WindowStorage implements IStorage {
+    private globalFields;
+    /**
+     * Constructor
+     * @param globalFields Global fields
+     */
+    constructor(globalFields: string[]);
+    /**
+     * Get data
+     * @param key Key name
+     */
+    getData<T>(key: string): T | undefined;
+    /**
+     * Get data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getData<T>(key: string, defaultValue: T): T;
+    /**
+     * Get object data
+     * @param key Key name
+     */
+    getObject<T extends {}>(key: string): T | undefined;
+    /**
+     * Set data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setData(key: string, data: unknown): void;
+}

package/lib/cjs/storage/WindowStorage.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WindowStorage = void 0;
+const StorageUtils_1 = require("../StorageUtils");
+const Utils_1 = require("../Utils");
+/**
+ * Window storage
+ * https://developer.mozilla.org/en-US/docs/Web/API/Storage
+ */
+class WindowStorage {
+    /**
+     * Constructor
+     * @param globalFields Global fields
+     */
+    constructor(globalFields) {
+        this.globalFields = globalFields;
+        if (globalFields.length == 0)
+            return;
+        // Copy global fields to session storage where first item does not exist
+        const firsItem = sessionStorage.getItem(globalFields[0]);
+        if (firsItem)
+            return;
+        globalFields.forEach((field) => {
+            const data = localStorage.getItem(field);
+            if (data != null) {
+                sessionStorage.setItem(field, data);
+            }
+        });
+    }
+    /**
+     * Get data
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getData(key, defaultValue) {
+        // Get storage
+        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 object data
+     * @param key Key name
+     */
+    getObject(key) {
+        // Get storage
+        const data = sessionStorage.getItem(key);
+        if (data == null)
+            return undefined;
+        return JSON.parse(data);
+    }
+    /**
+     * Set data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setData(key, data) {
+        StorageUtils_1.StorageUtils.setSessionData(key, data);
+        if (this.globalFields.includes(key)) {
+            StorageUtils_1.StorageUtils.setLocalData(key, data);
+        }
+    }
+}
+exports.WindowStorage = WindowStorage;

package/lib/mjs/StorageUtils.d.ts

@@ -15,12 +15,17 @@ export declare namespace StorageUtils {
      * @param data Data, null for removal
      */
     function setSessionData(key: string, data: unknown): void;
+    /**
+     * Get local storage data
+     * @param key Key name
+     */
+    function getLocalData<T>(key: string): T | undefined;
     /**
      * Get local storage data
      * @param key Key name
      * @param defaultValue Default value
      */
-    function getLocalData<T>(key: string, defaultValue?: T): T | undefined;
+    function getLocalData<T>(key: string, defaultValue: T): T;
     /**
      * Get local storage object data
      * @param key Key name
@@ -30,7 +35,13 @@ export declare namespace StorageUtils {
      * Get session storage data
      * @param key Key name
      */
-    function getSessionData<T>(key: string, defaultValue?: T): T | undefined;
+    function getSessionData<T>(key: string): T | undefined;
+    /**
+     * Get session storage data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    function getSessionData<T>(key: string, defaultValue: T): T;
     /**
      * Get session storage object data
      * @param key Key name

package/lib/mjs/StorageUtils.js

@@ -44,6 +44,9 @@ export var StorageUtils;
     function getLocalData(key, defaultValue) {
         // Get storage
         const data = localStorage.getItem(key);
+        // No default value
+        if (defaultValue == null)
+            return Utils.parseString(data);
         // Return
         return Utils.parseString(data, defaultValue);
     }
@@ -63,10 +66,14 @@ export var StorageUtils;
     /**
      * Get session storage data
      * @param key Key name
+     * @param defaultValue Default value
      */
     function getSessionData(key, defaultValue) {
         // Get storage
         const data = sessionStorage.getItem(key);
+        // No default value
+        if (defaultValue == null)
+            return Utils.parseString(data);
         // Return
         return Utils.parseString(data, defaultValue);
     }

package/lib/mjs/Utils.d.ts

@@ -134,6 +134,13 @@ export declare namespace Utils {
      * @returns Updated fields
      */
     function objectUpdated(objNew: {}, objPrev: {}, ignoreFields?: string[], strict?: number): string[];
+    /**
+     * Parse string (JSON) to specific type, no type conversion
+     * For type conversion, please use DataTypes.convert
+     * @param input Input string
+     * @returns Parsed value
+     */
+    function parseString<T>(input: string | undefined | null): T | undefined;
     /**
      * Parse string (JSON) to specific type, no type conversion
      * For type conversion, please use DataTypes.convert
@@ -141,7 +148,7 @@ export declare namespace Utils {
      * @param defaultValue Default value
      * @returns Parsed value
      */
-    function parseString<T>(input: string | undefined | null, defaultValue?: T): T | undefined;
+    function parseString<T>(input: string | undefined | null, defaultValue: T): T;
     /**
      * Remove non letters
      * @param input Input string

package/lib/mjs/Utils.js

@@ -265,6 +265,7 @@ export var Utils;
     Utils.objectUpdated = objectUpdated;
     /**
      * Parse string (JSON) to specific type, no type conversion
+     * When return type depends on parameter value, uses function overloading, otherwise uses conditional type
      * For type conversion, please use DataTypes.convert
      * @param input Input string
      * @param defaultValue Default value

package/lib/mjs/index.d.ts

@@ -1,4 +1,6 @@
 export * from './types/FormData';
+export * from './storage/IStorage';
+export * from './storage/WindowStorage';
 export * from './DataTypes';
 export * from './DateUtils';
 export * from './DomUtils';

package/lib/mjs/index.js

@@ -1,4 +1,6 @@
 export * from './types/FormData';
+export * from './storage/IStorage';
+export * from './storage/WindowStorage';
 export * from './DataTypes';
 export * from './DateUtils';
 export * from './DomUtils';

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

@@ -0,0 +1,33 @@
+/**
+ * Storage interface
+ */
+export interface IStorage {
+    /**
+     * Get data
+     * @param key Key name
+     */
+    getData<T>(key: string): T | undefined;
+    /**
+     * Get data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getData<T>(key: string, defaultValue: T): T;
+    /**
+     * Get session storage object data
+     * @param key Key name
+     */
+    getObject<T extends {}>(key: string): T | undefined;
+    /**
+     * Set data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setData(key: string, data: unknown): void;
+}
+/**
+ * Storage constructor interface
+ */
+export interface IStorageConstructor {
+    new (globalFields: string[]): IStorage;
+}

package/lib/mjs/storage/IStorage.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,35 @@
+import { IStorage } from './IStorage';
+/**
+ * Window storage
+ * https://developer.mozilla.org/en-US/docs/Web/API/Storage
+ */
+export declare class WindowStorage implements IStorage {
+    private globalFields;
+    /**
+     * Constructor
+     * @param globalFields Global fields
+     */
+    constructor(globalFields: string[]);
+    /**
+     * Get data
+     * @param key Key name
+     */
+    getData<T>(key: string): T | undefined;
+    /**
+     * Get data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getData<T>(key: string, defaultValue: T): T;
+    /**
+     * Get object data
+     * @param key Key name
+     */
+    getObject<T extends {}>(key: string): T | undefined;
+    /**
+     * Set data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setData(key: string, data: unknown): void;
+}

package/lib/mjs/storage/WindowStorage.js

@@ -0,0 +1,63 @@
+import { StorageUtils } from '../StorageUtils';
+import { Utils } from '../Utils';
+/**
+ * Window storage
+ * https://developer.mozilla.org/en-US/docs/Web/API/Storage
+ */
+export class WindowStorage {
+    /**
+     * Constructor
+     * @param globalFields Global fields
+     */
+    constructor(globalFields) {
+        this.globalFields = globalFields;
+        if (globalFields.length == 0)
+            return;
+        // Copy global fields to session storage where first item does not exist
+        const firsItem = sessionStorage.getItem(globalFields[0]);
+        if (firsItem)
+            return;
+        globalFields.forEach((field) => {
+            const data = localStorage.getItem(field);
+            if (data != null) {
+                sessionStorage.setItem(field, data);
+            }
+        });
+    }
+    /**
+     * Get data
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getData(key, defaultValue) {
+        // Get storage
+        const data = sessionStorage.getItem(key);
+        // No default value
+        if (defaultValue == null)
+            return Utils.parseString(data);
+        // Return
+        return Utils.parseString(data, defaultValue);
+    }
+    /**
+     * Get object data
+     * @param key Key name
+     */
+    getObject(key) {
+        // Get storage
+        const data = sessionStorage.getItem(key);
+        if (data == null)
+            return undefined;
+        return JSON.parse(data);
+    }
+    /**
+     * Set data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setData(key, data) {
+        StorageUtils.setSessionData(key, data);
+        if (this.globalFields.includes(key)) {
+            StorageUtils.setLocalData(key, data);
+        }
+    }
+}

package/package.json

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

package/src/StorageUtils.ts

@@ -44,17 +44,36 @@ export namespace StorageUtils {
         );
     }
 
+    /**
+     * Get local storage data
+     * @param key Key name
+     */
+    export function getLocalData<T>(key: string): T | undefined;
+
+    /**
+     * Get local storage data
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    export function getLocalData<T>(key: string, defaultValue: T): T;
+
     /**
      * Get local storage data
      * @param key Key name
      * @param defaultValue Default value
      */
-    export function getLocalData<T>(key: string, defaultValue?: T) {
+    export function getLocalData<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);
+
         // Return
-        return Utils.parseString(data, defaultValue);
+        return Utils.parseString<T>(data, defaultValue);
     }
 
     /**
@@ -72,12 +91,32 @@ export namespace StorageUtils {
      * Get session storage data
      * @param key Key name
      */
-    export function getSessionData<T>(key: string, defaultValue?: T) {
+    export function getSessionData<T>(key: string): T | undefined;
+
+    /**
+     * Get session storage data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    export function getSessionData<T>(key: string, defaultValue: T): T;
+
+    /**
+     * Get session storage data
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    export function getSessionData<T>(
+        key: string,
+        defaultValue?: T
+    ): T | undefined {
         // Get storage
         const data = sessionStorage.getItem(key);
 
+        // No default value
+        if (defaultValue == null) return Utils.parseString<T>(data);
+
         // Return
-        return Utils.parseString(data, defaultValue);
+        return Utils.parseString<T>(data, defaultValue);
     }
 
     /**

package/src/Utils.ts

@@ -365,6 +365,29 @@ export namespace Utils {
      * Parse string (JSON) to specific type, no type conversion
      * For type conversion, please use DataTypes.convert
      * @param input Input string
+     * @returns Parsed value
+     */
+    export function parseString<T>(
+        input: string | undefined | null
+    ): T | undefined;
+
+    /**
+     * Parse string (JSON) to specific type, no type conversion
+     * For type conversion, please use DataTypes.convert
+     * @param input Input string
+     * @param defaultValue Default value
+     * @returns Parsed value
+     */
+    export function parseString<T>(
+        input: string | undefined | null,
+        defaultValue: T
+    ): T;
+
+    /**
+     * Parse string (JSON) to specific type, no type conversion
+     * When return type depends on parameter value, uses function overloading, otherwise uses conditional type
+     * For type conversion, please use DataTypes.convert
+     * @param input Input string
      * @param defaultValue Default value
      * @returns Parsed value
      */
@@ -373,7 +396,7 @@ export namespace Utils {
         defaultValue?: T
     ): T | undefined {
         // Undefined and empty case, return default value
-        if (input == null || input === '') return defaultValue;
+        if (input == null || input === '') return <T>defaultValue;
 
         // String
         if (typeof defaultValue === 'string') return <any>input;
@@ -382,7 +405,7 @@ export namespace Utils {
             // Date
             if (defaultValue instanceof Date) {
                 const date = new Date(input);
-                if (date == null) return defaultValue;
+                if (date == null) return <any>defaultValue;
                 return <any>date;
             }
 
@@ -393,7 +416,7 @@ export namespace Utils {
             return <T>json;
         } catch {
             if (defaultValue == null) return <any>input;
-            return defaultValue;
+            return <T>defaultValue;
         }
     }
 

package/src/index.ts

@@ -1,4 +1,8 @@
 export * from './types/FormData';
+
+export * from './storage/IStorage';
+export * from './storage/WindowStorage';
+
 export * from './DataTypes';
 export * from './DateUtils';
 export * from './DomUtils';

package/src/storage/IStorage.ts

@@ -0,0 +1,37 @@
+/**
+ * Storage interface
+ */
+export interface IStorage {
+    /**
+     * Get data
+     * @param key Key name
+     */
+    getData<T>(key: string): T | undefined;
+
+    /**
+     * Get data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getData<T>(key: string, defaultValue: T): T;
+
+    /**
+     * Get session storage object data
+     * @param key Key name
+     */
+    getObject<T extends {}>(key: string): T | undefined;
+
+    /**
+     * Set data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setData(key: string, data: unknown): void;
+}
+
+/**
+ * Storage constructor interface
+ */
+export interface IStorageConstructor {
+    new (globalFields: string[]): IStorage;
+}

package/src/storage/WindowStorage.ts

@@ -0,0 +1,80 @@
+import { StorageUtils } from '../StorageUtils';
+import { Utils } from '../Utils';
+import { IStorage } from './IStorage';
+
+/**
+ * Window storage
+ * https://developer.mozilla.org/en-US/docs/Web/API/Storage
+ */
+export class WindowStorage implements IStorage {
+    /**
+     * Constructor
+     * @param globalFields Global fields
+     */
+    constructor(private globalFields: string[]) {
+        if (globalFields.length == 0) return;
+
+        // Copy global fields to session storage where first item does not exist
+        const firsItem = sessionStorage.getItem(globalFields[0]);
+        if (firsItem) return;
+
+        globalFields.forEach((field) => {
+            const data = localStorage.getItem(field);
+            if (data != null) {
+                sessionStorage.setItem(field, data);
+            }
+        });
+    }
+
+    /**
+     * Get data
+     * @param key Key name
+     */
+    getData<T>(key: string): T | undefined;
+
+    /**
+     * Get data with default value
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getData<T>(key: string, defaultValue: T): T;
+
+    /**
+     * Get data
+     * @param key Key name
+     * @param defaultValue Default value
+     */
+    getData<T>(key: string, defaultValue?: T): T | undefined {
+        // Get storage
+        const data = sessionStorage.getItem(key);
+
+        // No default value
+        if (defaultValue == null) return Utils.parseString<T>(data);
+
+        // Return
+        return Utils.parseString<T>(data, defaultValue);
+    }
+
+    /**
+     * Get object data
+     * @param key Key name
+     */
+    getObject<T extends {}>(key: string) {
+        // Get storage
+        const data = sessionStorage.getItem(key);
+        if (data == null) return undefined;
+        return <T>JSON.parse(data);
+    }
+
+    /**
+     * Set data
+     * @param key Key name
+     * @param data  Data, null for removal
+     */
+    setData(key: string, data: unknown) {
+        StorageUtils.setSessionData(key, data);
+        if (this.globalFields.includes(key)) {
+            StorageUtils.setLocalData(key, data);
+        }
+    }
+}