@etsoo/shared 1.0.82 → 1.0.86

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
 
@@ -92,8 +95,6 @@ DOM/window related utilities
 |isJSONContentType|Is JSON content type|
 |mergeFormData|Merge form data to primary one|
 |mergeURLSearchParams|Merge URL search parameters|
-|saveCountry|Save country name|
-|saveCulture|Save culture name|
 |setFocus|Set HTML element focus by name|
 
 ## ExtendUtils

package/lib/cjs/DomUtils.d.ts

@@ -8,11 +8,11 @@ export declare namespace DomUtils {
     /**
      * Language cache parameter name
      */
-    const Culture = "culture";
+    const CultureField = "culture";
     /**
      * Country cache parameter name
      */
-    const Country = "country";
+    const CountryField = "country";
     /**
      * Clear form data
      * @param data Form data
@@ -94,16 +94,6 @@ export declare namespace DomUtils {
      * @param data New simple object data to merge
      */
     function mergeURLSearchParams(base: URLSearchParams, data: DataTypes.SimpleObject): URLSearchParams;
-    /**
-     * Save country name
-     * @param country Country name
-     */
-    function saveCountry(country: string): void;
-    /**
-     * Save culture name
-     * @param culture Culture name
-     */
-    function saveCulture(culture: string): void;
     /**
      * Set HTML element focus by name
      * @param name Element name or first collection item

package/lib/cjs/DomUtils.js

@@ -16,11 +16,11 @@ var DomUtils;
     /**
      * Language cache parameter name
      */
-    DomUtils.Culture = 'culture';
+    DomUtils.CultureField = 'culture';
     /**
      * Country cache parameter name
      */
-    DomUtils.Country = 'country';
+    DomUtils.CountryField = 'country';
     /**
      * Clear form data
      * @param data Form data
@@ -156,12 +156,12 @@ var DomUtils;
      * Current detected country
      */
     DomUtils.detectedCountry = (() => {
+        var _a, _b;
         // URL first, then local storage
         let country;
         try {
             country =
-                new URL(location.href).searchParams.get(DomUtils.Country) ||
-                    localStorage.getItem(DomUtils.Country);
+                (_b = (_a = new URL(location.href).searchParams.get(DomUtils.CountryField)) !== null && _a !== void 0 ? _a : sessionStorage.getItem(DomUtils.CountryField)) !== null && _b !== void 0 ? _b : localStorage.getItem(DomUtils.CountryField);
         }
         catch {
             country = null;
@@ -173,12 +173,12 @@ var DomUtils;
      * Current detected culture
      */
     DomUtils.detectedCulture = (() => {
+        var _a, _b;
         // URL first, then local storage
         let culture;
         try {
             culture =
-                new URL(location.href).searchParams.get(DomUtils.Culture) ||
-                    localStorage.getItem(DomUtils.Culture);
+                (_b = (_a = new URL(location.href).searchParams.get(DomUtils.CultureField)) !== null && _a !== void 0 ? _a : sessionStorage.getItem(DomUtils.CultureField)) !== null && _b !== void 0 ? _b : localStorage.getItem(DomUtils.CultureField);
         }
         catch {
             culture = null;
@@ -342,22 +342,6 @@ var DomUtils;
         return base;
     }
     DomUtils.mergeURLSearchParams = mergeURLSearchParams;
-    /**
-     * Save country name
-     * @param country Country name
-     */
-    function saveCountry(country) {
-        localStorage.setItem(DomUtils.Country, country);
-    }
-    DomUtils.saveCountry = saveCountry;
-    /**
-     * Save culture name
-     * @param culture Culture name
-     */
-    function saveCulture(culture) {
-        localStorage.setItem(DomUtils.Culture, culture);
-    }
-    DomUtils.saveCulture = saveCulture;
     /**
      * Set HTML element focus by name
      * @param name Element name or first collection item

package/lib/cjs/StorageUtils.d.ts

@@ -37,7 +37,7 @@ export declare namespace StorageUtils {
      */
     function getSessionData<T>(key: string): T | undefined;
     /**
-     * Get session storage data
+     * Get session storage data with default value
      * @param key Key name
      * @param defaultValue Default value
      */

package/lib/cjs/StorageUtils.js

@@ -69,6 +69,7 @@ var StorageUtils;
     /**
      * Get session storage data
      * @param key Key name
+     * @param defaultValue Default value
      */
     function getSessionData(key, defaultValue) {
         // Get storage

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,34 @@
+/**
+ * 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
+     * @param persistance Persist the data, false will stop persistance
+     */
+    setData(key: string, data: unknown, persistance?: boolean): void;
+}
+/**
+ * Storage constructor interface
+ */
+export interface IStorageConstructor {
+    new (globalFields: string[], callback: (field: string, data: string | null) => string | null): 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,37 @@
+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
+     * @param callback Field and data callback
+     */
+    constructor(globalFields: string[], callback: (field: string, data: string | null) => string | null);
+    /**
+     * 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
+     * @param persistance Persist the data, false will stop persistance
+     */
+    setData(key: string, data: unknown, persistance?: boolean): void;
+}

package/lib/cjs/storage/WindowStorage.js

@@ -0,0 +1,72 @@
+"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
+     * @param callback Field and data callback
+     */
+    constructor(globalFields, callback) {
+        this.globalFields = globalFields;
+        if (globalFields.length == 0)
+            return;
+        // Copy global fields to session storage where first item does not exist
+        // Duplicate browser tab would copy the session storage
+        const firsItem = sessionStorage.getItem(globalFields[0]);
+        if (firsItem)
+            return;
+        globalFields.forEach((field) => {
+            const data = callback(field, localStorage.getItem(field));
+            if (data == null)
+                sessionStorage.removeItem(field);
+            else
+                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
+     * @param persistance Persist the data, false will stop persistance
+     */
+    setData(key, data, persistance) {
+        StorageUtils_1.StorageUtils.setSessionData(key, data);
+        if (persistance ||
+            (persistance == null && this.globalFields.includes(key))) {
+            StorageUtils_1.StorageUtils.setLocalData(key, data);
+        }
+    }
+}
+exports.WindowStorage = WindowStorage;

package/lib/mjs/DomUtils.d.ts

@@ -8,11 +8,11 @@ export declare namespace DomUtils {
     /**
      * Language cache parameter name
      */
-    const Culture = "culture";
+    const CultureField = "culture";
     /**
      * Country cache parameter name
      */
-    const Country = "country";
+    const CountryField = "country";
     /**
      * Clear form data
      * @param data Form data
@@ -94,16 +94,6 @@ export declare namespace DomUtils {
      * @param data New simple object data to merge
      */
     function mergeURLSearchParams(base: URLSearchParams, data: DataTypes.SimpleObject): URLSearchParams;
-    /**
-     * Save country name
-     * @param country Country name
-     */
-    function saveCountry(country: string): void;
-    /**
-     * Save culture name
-     * @param culture Culture name
-     */
-    function saveCulture(culture: string): void;
     /**
      * Set HTML element focus by name
      * @param name Element name or first collection item

package/lib/mjs/DomUtils.js

@@ -13,11 +13,11 @@ export var DomUtils;
     /**
      * Language cache parameter name
      */
-    DomUtils.Culture = 'culture';
+    DomUtils.CultureField = 'culture';
     /**
      * Country cache parameter name
      */
-    DomUtils.Country = 'country';
+    DomUtils.CountryField = 'country';
     /**
      * Clear form data
      * @param data Form data
@@ -153,12 +153,12 @@ export var DomUtils;
      * Current detected country
      */
     DomUtils.detectedCountry = (() => {
+        var _a, _b;
         // URL first, then local storage
         let country;
         try {
             country =
-                new URL(location.href).searchParams.get(DomUtils.Country) ||
-                    localStorage.getItem(DomUtils.Country);
+                (_b = (_a = new URL(location.href).searchParams.get(DomUtils.CountryField)) !== null && _a !== void 0 ? _a : sessionStorage.getItem(DomUtils.CountryField)) !== null && _b !== void 0 ? _b : localStorage.getItem(DomUtils.CountryField);
         }
         catch {
             country = null;
@@ -170,12 +170,12 @@ export var DomUtils;
      * Current detected culture
      */
     DomUtils.detectedCulture = (() => {
+        var _a, _b;
         // URL first, then local storage
         let culture;
         try {
             culture =
-                new URL(location.href).searchParams.get(DomUtils.Culture) ||
-                    localStorage.getItem(DomUtils.Culture);
+                (_b = (_a = new URL(location.href).searchParams.get(DomUtils.CultureField)) !== null && _a !== void 0 ? _a : sessionStorage.getItem(DomUtils.CultureField)) !== null && _b !== void 0 ? _b : localStorage.getItem(DomUtils.CultureField);
         }
         catch {
             culture = null;
@@ -339,22 +339,6 @@ export var DomUtils;
         return base;
     }
     DomUtils.mergeURLSearchParams = mergeURLSearchParams;
-    /**
-     * Save country name
-     * @param country Country name
-     */
-    function saveCountry(country) {
-        localStorage.setItem(DomUtils.Country, country);
-    }
-    DomUtils.saveCountry = saveCountry;
-    /**
-     * Save culture name
-     * @param culture Culture name
-     */
-    function saveCulture(culture) {
-        localStorage.setItem(DomUtils.Culture, culture);
-    }
-    DomUtils.saveCulture = saveCulture;
     /**
      * Set HTML element focus by name
      * @param name Element name or first collection item

package/lib/mjs/StorageUtils.d.ts

@@ -37,7 +37,7 @@ export declare namespace StorageUtils {
      */
     function getSessionData<T>(key: string): T | undefined;
     /**
-     * Get session storage data
+     * Get session storage data with default value
      * @param key Key name
      * @param defaultValue Default value
      */

package/lib/mjs/StorageUtils.js

@@ -66,6 +66,7 @@ export var StorageUtils;
     /**
      * Get session storage data
      * @param key Key name
+     * @param defaultValue Default value
      */
     function getSessionData(key, defaultValue) {
         // Get storage

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,34 @@
+/**
+ * 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
+     * @param persistance Persist the data, false will stop persistance
+     */
+    setData(key: string, data: unknown, persistance?: boolean): void;
+}
+/**
+ * Storage constructor interface
+ */
+export interface IStorageConstructor {
+    new (globalFields: string[], callback: (field: string, data: string | null) => string | null): IStorage;
+}

package/lib/mjs/storage/IStorage.js

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

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

@@ -0,0 +1,37 @@
+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
+     * @param callback Field and data callback
+     */
+    constructor(globalFields: string[], callback: (field: string, data: string | null) => string | null);
+    /**
+     * 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
+     * @param persistance Persist the data, false will stop persistance
+     */
+    setData(key: string, data: unknown, persistance?: boolean): void;
+}

package/lib/mjs/storage/WindowStorage.js

@@ -0,0 +1,68 @@
+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
+     * @param callback Field and data callback
+     */
+    constructor(globalFields, callback) {
+        this.globalFields = globalFields;
+        if (globalFields.length == 0)
+            return;
+        // Copy global fields to session storage where first item does not exist
+        // Duplicate browser tab would copy the session storage
+        const firsItem = sessionStorage.getItem(globalFields[0]);
+        if (firsItem)
+            return;
+        globalFields.forEach((field) => {
+            const data = callback(field, localStorage.getItem(field));
+            if (data == null)
+                sessionStorage.removeItem(field);
+            else
+                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
+     * @param persistance Persist the data, false will stop persistance
+     */
+    setData(key, data, persistance) {
+        StorageUtils.setSessionData(key, data);
+        if (persistance ||
+            (persistance == null && this.globalFields.includes(key))) {
+            StorageUtils.setLocalData(key, data);
+        }
+    }
+}

package/package.json

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

package/src/DomUtils.ts

@@ -15,12 +15,12 @@ export namespace DomUtils {
     /**
      * Language cache parameter name
      */
-    export const Culture = 'culture';
+    export const CultureField = 'culture';
 
     /**
      * Country cache parameter name
      */
-    export const Country = 'country';
+    export const CountryField = 'country';
 
     /**
      * Clear form data
@@ -198,8 +198,9 @@ export namespace DomUtils {
         let country: string | null;
         try {
             country =
-                new URL(location.href).searchParams.get(Country) ||
-                localStorage.getItem(Country);
+                new URL(location.href).searchParams.get(CountryField) ??
+                sessionStorage.getItem(CountryField) ??
+                localStorage.getItem(CountryField);
         } catch {
             country = null;
         }
@@ -216,8 +217,9 @@ export namespace DomUtils {
         let culture: string | null;
         try {
             culture =
-                new URL(location.href).searchParams.get(Culture) ||
-                localStorage.getItem(Culture);
+                new URL(location.href).searchParams.get(CultureField) ??
+                sessionStorage.getItem(CultureField) ??
+                localStorage.getItem(CultureField);
         } catch {
             culture = null;
         }
@@ -415,22 +417,6 @@ export namespace DomUtils {
         return base;
     }
 
-    /**
-     * Save country name
-     * @param country Country name
-     */
-    export function saveCountry(country: string) {
-        localStorage.setItem(Country, country);
-    }
-
-    /**
-     * Save culture name
-     * @param culture Culture name
-     */
-    export function saveCulture(culture: string) {
-        localStorage.setItem(Culture, culture);
-    }
-
     /**
      * Set HTML element focus by name
      * @param name Element name or first collection item

package/src/StorageUtils.ts

@@ -94,7 +94,7 @@ export namespace StorageUtils {
     export function getSessionData<T>(key: string): T | undefined;
 
     /**
-     * Get session storage data
+     * Get session storage data with default value
      * @param key Key name
      * @param defaultValue Default value
      */
@@ -103,6 +103,7 @@ export namespace StorageUtils {
     /**
      * Get session storage data
      * @param key Key name
+     * @param defaultValue Default value
      */
     export function getSessionData<T>(
         key: string,

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,41 @@
+/**
+ * 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
+     * @param persistance Persist the data, false will stop persistance
+     */
+    setData(key: string, data: unknown, persistance?: boolean): void;
+}
+
+/**
+ * Storage constructor interface
+ */
+export interface IStorageConstructor {
+    new (
+        globalFields: string[],
+        callback: (field: string, data: string | null) => string | null
+    ): IStorage;
+}

package/src/storage/WindowStorage.ts

@@ -0,0 +1,88 @@
+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
+     * @param callback Field and data callback
+     */
+    constructor(
+        private globalFields: string[],
+        callback: (field: string, data: string | null) => string | null
+    ) {
+        if (globalFields.length == 0) return;
+
+        // Copy global fields to session storage where first item does not exist
+        // Duplicate browser tab would copy the session storage
+        const firsItem = sessionStorage.getItem(globalFields[0]);
+        if (firsItem) return;
+
+        globalFields.forEach((field) => {
+            const data = callback(field, localStorage.getItem(field));
+            if (data == null) sessionStorage.removeItem(field);
+            else 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
+     * @param persistance Persist the data, false will stop persistance
+     */
+    setData(key: string, data: unknown, persistance?: boolean) {
+        StorageUtils.setSessionData(key, data);
+        if (
+            persistance ||
+            (persistance == null && this.globalFields.includes(key))
+        ) {
+            StorageUtils.setLocalData(key, data);
+        }
+    }
+}