@etsoo/shared 1.0.82 → 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/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,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

@@ -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,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.82",
+    "version": "1.0.83",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

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,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);
+        }
+    }
+}