ztimson/webstorage-decorators
ztimson/webstorage-decorators
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Updated to 2.0

Browse Source
This commit is contained in:
Zakary Timson 2021-01-28 10:24:11 -05:00
parent ca05a31987
commit 311a4311ac
16 changed files with 333 additions and 184 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -43,3 +43,4 @@ Thumbs.db
/dist /dist
dist.tgz dist.tgz
/.ng_pkg_build /.ng_pkg_build
/package-lock.json

12
jest.config.js Normal file
View File

@ -0,0 +1,12 @@
module.exports = {
"reporters": ["default"],
"roots": [
"<rootDir>/tests"
],
"testMatch": [
"**/?(*.)+(spec|test).+(ts|tsx|js)"
],
"transform": {
".+\\.(ts)$": "ts-jest"
},
}

15
lib/index.js
View File

@ -1,6 +1,13 @@
"use strict"; "use strict";
function __export(m) { var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p]; if (k2 === undefined) k2 = k;
} Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
__export(require("./src/index")); __exportStar(require("./src/index"), exports);

2
lib/src/index.d.ts vendored
View File

@ -1 +1 @@
export * from './webStorage'; export * from './webstorage';

15
lib/src/index.js
View File

@ -1,6 +1,13 @@
"use strict"; "use strict";
function __export(m) { var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p]; if (k2 === undefined) k2 = k;
} Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
__export(require("./webStorage")); __exportStar(require("./webstorage"), exports);

7
lib/src/webStorage.d.ts vendored
View File

@ -1,7 +0,0 @@
export interface WebStorageOptions {
fieldName?: string;
encryptionKey?: string;
defaultValue?: any;
}
export declare function LocalStorage(opts?: WebStorageOptions): (target: object, key: string) => void;
export declare function SessionStorage(opts?: WebStorageOptions): (target: object, key: string) => void;

32
lib/src/webStorage.js
View File

@ -1,32 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const crypto_js_1 = require("crypto-js");
function LocalStorage(opts = {}) {
return storage(localStorage, opts);
}
exports.LocalStorage = LocalStorage;
function SessionStorage(opts = {}) {
return storage(sessionStorage, opts);
}
exports.SessionStorage = SessionStorage;
function storage(storageType, opts = {}) {
return function (target, key) {
if (!opts.fieldName)
opts.fieldName = key;
Object.defineProperty(target, key, {
get: function () {
let value = storageType.getItem(opts.fieldName);
if (!value && opts.defaultValue != null)
return opts.defaultValue;
if (value != null && opts.encryptionKey)
value = crypto_js_1.AES.decrypt(JSON.parse(value), opts.encryptionKey).toString(crypto_js_1.enc.Utf8);
return JSON.parse(value);
},
set: function (value) {
if (value != null && opts.encryptionKey)
value = crypto_js_1.AES.encrypt(JSON.stringify(value), opts.encryptionKey).toString();
storageType.setItem(opts.fieldName, JSON.stringify(value));
}
});
};
}

42
lib/src/webstorage.d.ts vendored Normal file
View File

@ -0,0 +1,42 @@
/**
* Options to be used with WebStorage decorators
* @category WebStorage
*/
export interface WebStorageOptions {
/** Default value to provide if storage is empty */
default?: any;
/** Key to save under */
key?: string;
}
/**
* Automatically syncs localStorage with the decorated property.
*
* **Example**
* ```
* class Example {
* @LocalStorage() lastLogin: string;
* @LocalStorage(false, {key: '_hideMenu'}) hideMenu: boolean;
* }
* ```
*
* @category WebStorage
* @param defaultValue Default value to return if property does no exist inside localStorage.
* @param opts Any additional options
*/
export declare function LocalStorage(defaultValue?: any, opts?: WebStorageOptions): (target: object, key: string) => void;
/**
* Automatically syncs sessionStorage with the decorated property.
*
* **Example**
* ```
* class Example {
* @SessionStorage() lastLogin: string;
* @SessionStorage(false, {key: '_hideMenu'}) hideMenu: boolean;
* }
* ```
*
* @category WebStorage
* @param defaultValue Default value to return if property does no exist inside sessionStorage.
* @param opts Any additional options
*/
export declare function SessionStorage(defaultValue?: any, opts?: WebStorageOptions): (target: object, key: string) => void;

72
lib/src/webstorage.js Normal file
View File

@ -0,0 +1,72 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.SessionStorage = exports.LocalStorage = void 0;
/**
* Automatically syncs localStorage with the decorated property.
*
* **Example**
* ```
* class Example {
* @LocalStorage() lastLogin: string;
* @LocalStorage(false, {key: '_hideMenu'}) hideMenu: boolean;
* }
* ```
*
* @category WebStorage
* @param defaultValue Default value to return if property does no exist inside localStorage.
* @param opts Any additional options
*/
function LocalStorage(defaultValue, opts = {}) {
opts.default = defaultValue;
return storage(localStorage, opts);
}
exports.LocalStorage = LocalStorage;
/**
* Automatically syncs sessionStorage with the decorated property.
*
* **Example**
* ```
* class Example {
* @SessionStorage() lastLogin: string;
* @SessionStorage(false, {key: '_hideMenu'}) hideMenu: boolean;
* }
* ```
*
* @category WebStorage
* @param defaultValue Default value to return if property does no exist inside sessionStorage.
* @param opts Any additional options
*/
function SessionStorage(defaultValue, opts = {}) {
opts.default = defaultValue;
return storage(sessionStorage, opts);
}
exports.SessionStorage = SessionStorage;
/**
* **Internal use only**
*
* Overrides the properties getter/setter methods to read/write from the provided storage endpoint.
*
* @hidden
* @category WebStorage
* @param storage Web Storage API
* @param opts Any additional options
*/
function storage(storage, opts) {
return function (target, key) {
if (!opts.key)
opts.key = key;
Object.defineProperty(target, key, {
get: function () {
const storageVal = storage.getItem(opts.key);
if (storageVal == null || storageVal == 'null' || storageVal == 'undefined')
return opts.default || null;
return JSON.parse(storageVal);
},
set: function (value) {
if (value == null)
storage.removeItem(opts.key);
storage.setItem(opts.key, JSON.stringify(value));
}
});
};
}

29
package.json
View File

@ -1,41 +1,32 @@
{ {
"name": "webstorage-decorators", "name": "webstorage-decorators",
"version": "1.0.1", "version": "2.0.0",
"description": "Decorators to sync variable to Local/Session storage", "description": "Decorators to sync class properties to Local/Session storage",
"main": "./lib/index.js", "main": "./lib/index.js",
"typings": "./lib/index.d.ts", "typings": "./lib/index.d.ts",
"scripts": { "scripts": {
"build": "tsc", "build": "tsc",
"test": "jest" "test": "jest --verbose"
}, },
"files": [ "files": [
"lib" "lib"
], ],
"keywords": [ "keywords": [
"Decorators",
"LocalStorage", "LocalStorage",
"SessionStorage", "SessionStorage",
"WebStorage" "WebStorage"
], ],
"author": "Zak Timson", "author": "Zak Timson",
"license": "ISC", "license": "ISC",
"jest": {
"moduleFileExtensions": [
"ts",
"js"
],
"transform": {
"\\.ts$": "<rootDir>/node_modules/ts-jest/preprocessor.js"
},
"testRegex": "/src/.*\\.spec\\.ts$"
},
"dependencies": { "dependencies": {
"@types/crypto-js": "^3.1.39", "@types/crypto-js": "^4.0.1",
"crypto-js": "^3.1.9-1" "crypto-js": "^4.0.0"
}, },
"devDependencies": { "devDependencies": {
"@types/jest": "^22.2.3", "@types/jest": "^26.0.15",
"jest": "^22.4.3", "jest": "^26.6.0",
"ts-jest": "^22.4.4", "ts-jest": "^26.4.1",
"typescript": "^2.8.3" "typescript": "^4.0.3"
} }
} }

2
src/index.ts
View File

@ -1 +1 @@
export * from './webStorage'; export * from './webstorage';

80
src/webStorage.spec.ts
View File

@ -1,80 +0,0 @@
import {LocalStorage, SessionStorage} from './index'
class TestClass {
@LocalStorage() localStorage: any;
@SessionStorage() sessionStorage: any;
@LocalStorage({fieldName: 'customKey'}) customKey: any;
@LocalStorage({fieldName: 'encrypted', encryptionKey: 'ENCRYPTION_KEY'}) encrypted: any;
@LocalStorage({defaultValue: 'test'}) defaultedStorage: any;
@LocalStorage({defaultValue: {a: true, b: 'test', c: 3.14}}) objectDefault: any;
}
describe('LocalStorage Tests', () => {
it('LocalStorage', () => {
let testValue = Math.random().toString(36).substring(7);
new TestClass().localStorage = testValue;
expect(JSON.parse(<string>localStorage.getItem('_localStorage'))).toEqual(testValue);
});
it('SessionStorage', () => {
let testValue = Math.random().toString(36).substring(7);
new TestClass().sessionStorage = testValue;
expect(JSON.parse(<string>sessionStorage.getItem('_sessionStorage'))).toEqual(testValue);
});
it('Custom Key', () => {
let testValue = Math.random().toString(36).substring(7);
new TestClass().customKey = testValue;
expect(JSON.parse(<string>localStorage.getItem('customKey'))).toEqual(testValue);
});
it('Maintain Object Structure', () => {
let testObject = new TestClass();
let testValue = {a: Math.random().toString(36).substring(7), b: Math.random(), c: true, d: [{a: false}, {a: true}]};
testObject.localStorage = testValue;
expect(testObject.localStorage).toEqual(testValue);
});
describe('Default', () => {
it('Default Value', () => {
localStorage.removeItem('_defaultedStorage');
let testObject = new TestClass();
expect(testObject.defaultedStorage).toEqual('test');
});
it('Key Already Has Value', () => {
let testValue = {a: Math.random().toString(36).substring(7), b: Math.random(), c: true, d: [{a: false}, {a: true}]};
localStorage.setItem('_defaultedStorage', JSON.stringify(testValue));
let testObject = new TestClass();
expect(testObject.defaultedStorage).toEqual(testValue);
});
it('Using Object As Default', () => {
let testObject = new TestClass();
expect(testObject.objectDefault).toEqual({a: true, b: 'test', c: 3.14});
})
});
describe('Encryption Tests', () => {
it('Encrypt', () => {
let testObject = new TestClass();
let testValue = Math.random().toString(36).substring(7);
testObject.encrypted = testValue;
expect(JSON.parse(<string>localStorage.getItem('encrypted'))).not.toEqual(testValue);
});
it('Decrypt', () => {
let testObject = new TestClass();
let testValue = Math.random().toString(36).substring(7);
testObject.encrypted = testValue;
expect(testObject.encrypted).toEqual(testValue);
});
it('Maintain Object Structure', () => {
let testObject = new TestClass();
let testValue = {a: Math.random().toString(36).substring(7), b: Math.random(), c: true, d: [{a: false}, {a: true}]};
testObject.encrypted = testValue;
expect(testObject.encrypted).toEqual(testValue);
});
});
});

36
src/webStorage.ts
View File

@ -1,36 +0,0 @@
import {AES, enc} from 'crypto-js';
export interface WebStorageOptions {
fieldName?: string;
encryptionKey?: string;
defaultValue?: any;
}
export function LocalStorage(opts: WebStorageOptions) {
if(!opts) opts = {};
return storage(localStorage, opts);
}
export function SessionStorage(opts: WebStorageOptions) {
if(!opts) opts = {};
return storage(sessionStorage, opts);
}
function storage(storageType: Storage, opts: WebStorageOptions) {
return function(target: object, key: string) {
if(!opts.fieldName) opts.fieldName = key;
Object.defineProperty(target, key, {
get: function() {
let value = storageType.getItem(<string>opts.fieldName);
if(!value && opts.defaultValue != null) return opts.defaultValue;
if(value != null && opts.encryptionKey) value = AES.decrypt(JSON.parse(value), opts.encryptionKey).toString(enc.Utf8);
return JSON.parse(<string>value);
},
set: function(value) {
if(value != null && opts.encryptionKey) value = AES.encrypt(JSON.stringify(value), opts.encryptionKey).toString();
storageType.setItem(<string>opts.fieldName, JSON.stringify(value));
}
});
};
}

77
src/webstorage.ts Normal file
View File

@ -0,0 +1,77 @@
/**
* Options to be used with WebStorage decorators
* @category WebStorage
*/
export interface WebStorageOptions {
/** Default value to provide if storage is empty */
default?: any
/** Key to save under */
key?: string
}
/**
* Automatically syncs localStorage with the decorated property.
*
* **Example**
* ```
* class Example {
* @LocalStorage() lastLogin: string;
* @LocalStorage(false, {key: '_hideMenu'}) hideMenu: boolean;
* }
* ```
*
* @category WebStorage
* @param defaultValue Default value to return if property does no exist inside localStorage.
* @param opts Any additional options
*/
export function LocalStorage(defaultValue?: any, opts: WebStorageOptions = {}) {
opts.default = defaultValue;
return storage(localStorage, opts);
}
/**
* Automatically syncs sessionStorage with the decorated property.
*
* **Example**
* ```
* class Example {
* @SessionStorage() lastLogin: string;
* @SessionStorage(false, {key: '_hideMenu'}) hideMenu: boolean;
* }
* ```
*
* @category WebStorage
* @param defaultValue Default value to return if property does no exist inside sessionStorage.
* @param opts Any additional options
*/
export function SessionStorage(defaultValue?, opts: WebStorageOptions = {}) {
opts.default = defaultValue;
return storage(sessionStorage, opts);
}
/**
* **Internal use only**
*
* Overrides the properties getter/setter methods to read/write from the provided storage endpoint.
*
* @hidden
* @category WebStorage
* @param storage Web Storage API
* @param opts Any additional options
*/
function storage(storage: Storage, opts: WebStorageOptions) {
return function(target: object, key: string) {
if(!opts.key) opts.key = key;
Object.defineProperty(target, key, {
get: function() {
const storageVal = storage.getItem(<string>opts.key);
if(storageVal == null || storageVal == 'null' || storageVal == 'undefined') return opts.default || null;
return JSON.parse(storageVal);
},
set: function(value) {
if(value == null) storage.removeItem(<string>opts.key);
storage.setItem(<string>opts.key, JSON.stringify(value));
}
});
};
}

91
tests/webstorage.spec.ts Normal file
View File

@ -0,0 +1,91 @@
import {LocalStorage, SessionStorage} from "../src";
const CUSTOM_KEY = '__MY_KEY'
class TestClass {
@LocalStorage() localStorage: any;
@LocalStorage({a: true, b: 'test', c: 3.14}) defaultedLocalStorage: any;
@LocalStorage(null, {key: CUSTOM_KEY}) customLocalStorage: any;
@SessionStorage() sessionStorage: any;
@SessionStorage({a: true, b: 'test', c: 3.14}) defaultedSessionStorage: any;
@SessionStorage(null, {key: CUSTOM_KEY}) customSessionStorage: any;
}
describe('WebStorage', () => {
let testComponent: TestClass;
beforeEach(() => {
localStorage.clear();
testComponent = new TestClass();
});
describe('LocalStorage', () => {
test('NULL Value', () => {
expect(testComponent.localStorage).toBeNull();
testComponent.localStorage = 0;
expect(testComponent.localStorage).not.toBeNull();
testComponent.localStorage = null;
expect(testComponent.localStorage).toBeNull();
});
test('Default Value', () => expect(testComponent.defaultedLocalStorage.a).toBeTruthy());
test('Number Value', () => {
const testValue = Math.random();
testComponent.localStorage = testValue;
expect(localStorage.getItem('localStorage')).toBe(JSON.stringify(testValue));
expect(testComponent.localStorage).toBe(testValue);
});
test('String Value', () => {
const testValue = 'SOMETHING_RANDOM';
testComponent.localStorage = testValue;
expect(localStorage.getItem('localStorage')).toBe(JSON.stringify(testValue));
expect(testComponent.localStorage).toBe(testValue);
});
test('Object Value', () => {
const testValue = {a: Math.floor(Math.random() * 100), b: Math.random()};
testComponent.localStorage = testValue;
expect(localStorage.getItem('localStorage')).toBe(JSON.stringify(testValue));
expect(testComponent.localStorage).toStrictEqual(testValue);
});
test('Custom Key', () => {
const testValue = Math.random();
testComponent.customLocalStorage = testValue;
expect(localStorage.getItem(CUSTOM_KEY)).toBe(JSON.stringify(testValue));
expect(testComponent.customLocalStorage).toBe(testValue);
});
});
describe('SessionStorage', () => {
test('NULL Value', () => {
expect(testComponent.sessionStorage).toBeNull();
testComponent.sessionStorage = 0;
expect(testComponent.sessionStorage).not.toBeNull();
testComponent.sessionStorage = null;
expect(testComponent.sessionStorage).toBeNull();
});
test('Default Value', () => expect(testComponent.defaultedSessionStorage.a).toBeTruthy());
test('Number Value', () => {
const testValue = Math.random();
testComponent.sessionStorage = testValue;
expect(sessionStorage.getItem('sessionStorage')).toBe(JSON.stringify(testValue));
expect(testComponent.sessionStorage).toBe(testValue);
});
test('String Value', () => {
const testValue = 'SOMETHING_RANDOM';
testComponent.sessionStorage = testValue;
expect(sessionStorage.getItem('sessionStorage')).toBe(JSON.stringify(testValue));
expect(testComponent.sessionStorage).toBe(testValue);
});
test('Object Value', () => {
const testValue = {a: Math.floor(Math.random() * 100), b: Math.random()};
testComponent.sessionStorage = testValue;
expect(sessionStorage.getItem('sessionStorage')).toBe(JSON.stringify(testValue));
expect(testComponent.sessionStorage).toStrictEqual(testValue);
});
test('Custom Key', () => {
const testValue = Math.random();
testComponent.customSessionStorage = testValue;
expect(sessionStorage.getItem(CUSTOM_KEY)).toBe(JSON.stringify(testValue));
expect(testComponent.customSessionStorage).toBe(testValue);
});
});
});

4
tsconfig.json
View File

@ -4,7 +4,11 @@
"module": "commonjs", "module": "commonjs",
"declaration": true, "declaration": true,
"outDir": "lib", "outDir": "lib",
"typeRoots": [
"./node_modules/@types"
],
"strict": true, "strict": true,
"noImplicitAny": false,
"experimentalDecorators": true, "experimentalDecorators": true,
}, },
"include": [ "include": [