@degreesign/storage 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,53 +8,59 @@ Install using `yarn add @degreesign/storage` or `npm install @degreesign/storage
8
8
  ```typescript
9
9
  import {
10
10
  configureStorage,
11
+ saveData,
12
+ readData,
13
+ saveSecure,
14
+ readSecure,
11
15
  } from "@degreesign/storage";
12
-
13
- // configure storage system
14
- await configureStorage({
15
- storageKey: 'newAppData',
16
- dbName: 'myDatabase',
17
- storeName: 'users',
18
- encryptionKey: 'my-secret-key-123'
19
- });
20
-
21
- // quick save/read (unencrypted) only suitable for smaller data
22
- const user: UserData = { id: `1`, name: 'Hasn', email: 'hasn@example.com' };
23
- saveData({ key: `userData`, data: user });
24
- const storedUser = readData<UserData>(`userData`);
25
- console.log('Storage data:', storedUser);
26
- saveData({ key: `userData` }); // Removes the key and data
27
-
28
- // secure save/read (encrypted) useful for larger data
29
- await saveSecure({ key: `userData`, data: user });
30
- const dbUser = await readSecure<UserData>(`userData`);
31
- console.log('Database data:', dbUser);
32
- await saveSecure({ key: `userData` }); // Removes the key and data
33
16
  ```
34
17
 
35
18
  ## Browser Integration
36
19
  Use in browsers through CDN
37
- `<script src="https://cdn.jsdelivr.net/npm/@degreesign/storage@1.0.0/dist/browser/degreesign.min.js"></script>`
20
+ `<script src="https://cdn.jsdelivr.net/npm/@degreesign/storage@1.0.2/dist/browser/degreesign.min.js"></script>`
21
+
22
+ ```typescript
23
+ const {
24
+ configureStorage,
25
+ saveData,
26
+ readData,
27
+ saveSecure,
28
+ readSecure,
29
+ } = window.stored;
30
+ ```
31
+
32
+ ## Usage
38
33
 
39
34
  ```typescript
40
35
  // configure storage system
41
- await stored.configureStorage({
42
- storageKey: 'newAppData',
43
- dbName: 'myDatabase',
44
- storeName: 'users',
45
- encryptionKey: 'my-secret-key-123'
36
+ await configureStorage({
37
+ storageKey: 'app_name',
38
+ dbName: 'database_name',
39
+ storeName: 'dataset_name',
40
+ encryptionKey: 'encryption_key'
46
41
  });
47
42
 
48
- // quick save/read (unencrypted) only suitable for smaller data
49
- const user: UserData = { id: `1`, name: 'Hasn', email: 'hasn@example.com' };
50
- stored.saveData({ key: `userData`, data: user });
51
- const storedUser = stored.readData<UserData>(`userData`);
52
- console.log('Storage data:', storedUser);
53
- stored.saveData({ key: `userData` }); // Removes the key
54
-
55
- // secure save/read (encrypted) useful for larger data
56
- await stored.saveSecure({ key: `userData`, data: user });
57
- const dbUser = await stored.readSecure<UserData>(`userData`);
58
- console.log('Database data:', dbUser);
59
- await stored.saveSecure({ key: `userData` }); // Removes the key
43
+ // sample data
44
+ const
45
+ key = `sample_key`,
46
+ data: SampleType = { id: `1`, name: 'Hasn', email: 'hasn@example.com' };
47
+
48
+ /** quick unencrypted, only suitable for smaller data */
49
+ // save
50
+ saveData({ key, data });
51
+ // read
52
+ const unsecureData = readData<SampleType>(key);
53
+ console.log(`unsecureData`, unsecureData);
54
+ // clear
55
+ saveData({ key });
56
+
57
+
58
+ /** secure, useful for larger data */
59
+ // save
60
+ await saveSecure({ key, data });
61
+ // read
62
+ const secureData = await readSecure<SampleType>(key);
63
+ console.log(`secureData`, secureData);
64
+ // clear
65
+ await saveSecure({ key });
60
66
  ```
@@ -1,2 +1,2 @@
1
1
  /*! For license information please see degreesign.min.js.LICENSE.txt */
2
- !function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.stored=t():e.stored=t()}(this,()=>(()=>{"use strict";var e={28:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.migrateSecure=t.configureStorage=t.initialiseConfig=t.ENCRYPTION_KEY=t.STORE_NAME=t.DB_NAME=t.STORAGE_KEY=void 0;const a=r(205),o=r(247);let n,c="appData",i="appDB",s="appStorage";t.STORAGE_KEY=c,t.DB_NAME=i,t.STORE_NAME=s;const d="appConfig",y=async()=>{try{const e=localStorage.getItem(d);if(e){const r=JSON.parse(e);t.STORAGE_KEY=c=r.storageKey,t.DB_NAME=i=r.dbName||i,t.STORE_NAME=s=r.storeName||s,t.ENCRYPTION_KEY=n=r.encryptionKey?await(0,a.cryptoKey)(r.encryptionKey):void 0}}catch(e){console.log("initialiseConfig failed",e)}};t.initialiseConfig=y,t.configureStorage=async({storageKey:e,dbName:r,storeName:o,encryptionKey:y})=>{try{const l=localStorage.getItem(d);let u;l&&(u=JSON.parse(l));const p={storageKey:e,dbName:r||i,storeName:o||s,encryptionKey:y};localStorage.setItem(d,JSON.stringify(p)),t.STORAGE_KEY=c=e,p.dbName&&(t.DB_NAME=i=p.dbName),p.storeName&&(t.STORE_NAME=s=p.storeName),t.ENCRYPTION_KEY=n=y?await(0,a.cryptoKey)(y):void 0}catch(e){console.log("Error in configureStorage:",e)}},t.migrateSecure=async({storedKeys:e,newEncryptionKey:r,newDbName:c,newStoreName:d})=>{console.log("Data migration started...");const y=n,l=i,u=s;t.ENCRYPTION_KEY=n=await(0,a.cryptoKey)(r)??n,t.DB_NAME=i=c??i,t.STORE_NAME=s=d??s;for(let t=0;t<e.length;t++){const r=e[t];try{const e=await(0,o.readDB)({key:r,dbName:l,storeName:u}),t=e?y?await(0,a.decryptData)(e,y):JSON.parse(e):void 0,c=t?n?await(0,a.encryptData)(t,n):JSON.stringify(t):void 0;c&&await(0,o.saveDB)({key:r,data:c,dbName:i,storeName:s})}catch(e){console.log("migrateSecure failed",r,e)}}console.log("Data migration finished!")},y()},205:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.decrypt=t.encrypt=t.decryptData=t.encryptData=t.cryptoKey=void 0;const a=r(28),o=async(e,t)=>{try{const r=crypto.getRandomValues(new Uint8Array(12)),a=(new TextEncoder).encode(JSON.stringify(e)),o=await crypto.subtle.encrypt({name:"AES-GCM",iv:r},t,a),n=new Uint8Array(o),c=new Uint8Array(r.length+n.length);return c.set(r),c.set(n,r.length),btoa(String.fromCharCode(...c))}catch(t){console.log("encryptData failed",t);try{return JSON.stringify(e)}catch(e){}}},n=async(e,t)=>{try{const r=Uint8Array.from(atob(e),e=>e.charCodeAt(0)),a=r.slice(0,12),o=r.slice(12),n=await crypto.subtle.decrypt({name:"AES-GCM",iv:a},t,o);return JSON.parse((new TextDecoder).decode(n))}catch(e){return void console.log("decryptData failed",e)}};t.cryptoKey=async e=>{try{if(!e)return;const t=await crypto.subtle.importKey("raw",(new TextEncoder).encode(e),"PBKDF2",!1,["deriveKey"]);return await crypto.subtle.deriveKey({name:"PBKDF2",salt:(new TextEncoder).encode("salt"),iterations:1e5,hash:"SHA-256"},t,{name:"AES-GCM",length:256},!1,["encrypt","decrypt"])}catch(e){console.log("processKey failed",e)}},t.encryptData=o,t.decryptData=n,t.encrypt=async e=>{try{return a.ENCRYPTION_KEY?await o(e,a.ENCRYPTION_KEY):JSON.stringify(e)}catch(t){console.log("encrypt failed",t);try{return JSON.stringify(e)}catch(e){}}},t.decrypt=async e=>{try{return a.ENCRYPTION_KEY?await n(e,a.ENCRYPTION_KEY):JSON.parse(e)}catch(e){return void console.log("decrypt failed",e)}}},247:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.readSecure=t.saveSecure=t.readDB=t.saveDB=t.openDB=void 0;const a=r(28),o=r(205),n=({dbName:e,storeName:t,version:r=1}={})=>new Promise((o,n)=>{e=e||a.DB_NAME;const c=indexedDB.open(e,r);c.onupgradeneeded=()=>{t=t||a.STORE_NAME;const e=c.result;e.objectStoreNames.contains(t)||e.createObjectStore(t,{keyPath:"id"})},c.onsuccess=()=>o(c.result),c.onerror=()=>{console.log("openDB error",c.error),n(c.error)}}),c=async({key:e,data:t,dbName:r,storeName:a})=>{try{const o=await n({dbName:r,storeName:a});return new Promise(r=>{const n=o.transaction([a],"readwrite").objectStore(a),c=t?n.put({id:e,data:t}):n.delete(e);c.onsuccess=()=>r(!0),c.onerror=()=>{console.log("saveDB error",c.error),r(!1)},o.close()})}catch(e){return console.log("saveSecure failed",e),!1}},i=async({key:e,dbName:t,storeName:r})=>{try{const a=await n({dbName:t,storeName:r});return new Promise(t=>{const o=a.transaction([r],"readonly").objectStore(r).get(e);o.onsuccess=()=>t(o?.result?.data),o.onerror=()=>{console.log("readDB error",o.error),t(void 0)},a.close()})}catch(e){return void console.log("readDB failed",e)}};t.openDB=n,t.saveDB=c,t.readDB=i,t.saveSecure=async({key:e,data:t})=>await c({key:e,data:t?await(0,o.encrypt)(t):void 0,dbName:a.DB_NAME,storeName:a.STORE_NAME}),t.readSecure=async e=>{try{const t=await i({key:e,dbName:a.DB_NAME,storeName:a.STORE_NAME});return t?await(0,o.decrypt)(t):void 0}catch(e){return void console.log("readSecure failed",e)}}},421:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.readData=t.saveData=void 0;t.saveData=({key:e,data:t})=>{try{void 0===t?localStorage.removeItem(e):localStorage.setItem(e,JSON.stringify(t))}catch(e){console.log("saveData failed",e)}},t.readData=e=>{try{const t=localStorage.getItem(e);return t?JSON.parse(t):void 0}catch(e){return void console.log("readData failed",e)}}}},t={};function r(a){var o=t[a];if(void 0!==o)return o.exports;var n=t[a]={exports:{}};return e[a](n,n.exports,r),n.exports}var a={};return(()=>{var e=a;Object.defineProperty(e,"__esModule",{value:!0}),e.decryptData=e.encryptData=e.saveData=e.readData=e.saveSecure=e.readSecure=e.migrateSecure=e.configureStorage=e.initialiseConfig=void 0;const t=r(421);Object.defineProperty(e,"readData",{enumerable:!0,get:function(){return t.readData}}),Object.defineProperty(e,"saveData",{enumerable:!0,get:function(){return t.saveData}});const o=r(28);Object.defineProperty(e,"configureStorage",{enumerable:!0,get:function(){return o.configureStorage}}),Object.defineProperty(e,"initialiseConfig",{enumerable:!0,get:function(){return o.initialiseConfig}}),Object.defineProperty(e,"migrateSecure",{enumerable:!0,get:function(){return o.migrateSecure}});const n=r(247);Object.defineProperty(e,"readSecure",{enumerable:!0,get:function(){return n.readSecure}}),Object.defineProperty(e,"saveSecure",{enumerable:!0,get:function(){return n.saveSecure}});const c=r(205);Object.defineProperty(e,"decryptData",{enumerable:!0,get:function(){return c.decryptData}}),Object.defineProperty(e,"encryptData",{enumerable:!0,get:function(){return c.encryptData}})})(),a})());
2
+ !function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.stored=t():e.stored=t()}(this,()=>(()=>{"use strict";var e={28:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.migrateSecure=t.getConfig=t.configureStorage=void 0;const a=r(896),o=r(205);let n,c="appData",s="appDB",i="appStorage";const d="appConfig";t.configureStorage=async({storageKey:e,dbName:t,storeName:r,encryptionKey:a})=>{try{await(async()=>{try{const e=localStorage.getItem(d);if(e){const t=JSON.parse(e);c=t.storageKey,s=t.dbName||s,i=t.storeName||i,n=t.encryptionKey?await(0,o.cryptoKey)(t.encryptionKey):void 0}}catch(e){console.log("initialiseConfig failed",e)}})();const y=localStorage.getItem(d);let l;y&&(l=JSON.parse(y));const g={storageKey:e,dbName:t||s,storeName:r||i,encryptionKey:a};localStorage.setItem(d,JSON.stringify(g)),c=e,g.dbName&&(s=g.dbName),g.storeName&&(i=g.storeName),n=a?await(0,o.cryptoKey)(a):void 0}catch(e){console.log("configureStorage failed",e)}},t.getConfig=()=>({STORAGE_KEY:c,DB_NAME:s,STORE_NAME:i,ENCRYPTION_KEY:n}),t.migrateSecure=async({storedKeys:e,newEncryptionKey:t,newDbName:r,newStoreName:c})=>{console.log("Data migration started...");const d=n,y=s,l=i;n=await(0,o.cryptoKey)(t)??n,s=r??s,i=c??i;for(let t=0;t<e.length;t++){const r=e[t];try{const e=await(0,a.readDB)({key:r,dbName:y,storeName:l}),t=e?d?await(0,o.decryptData)(e,d):JSON.parse(e):void 0,c=t?n?await(0,o.encryptData)(t,n):JSON.stringify(t):void 0;c&&await(0,a.saveDB)({key:r,data:c,dbName:s,storeName:i})}catch(e){console.log("migrateSecure failed",r,e)}}console.log("Data migration finished!")}},205:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.decrypt=t.encrypt=t.decryptData=t.encryptData=t.cryptoKey=void 0;const a=r(28),o=async(e,t)=>{try{const r=crypto.getRandomValues(new Uint8Array(12)),a=(new TextEncoder).encode(JSON.stringify(e)),o=await crypto.subtle.encrypt({name:"AES-GCM",iv:r},t,a),n=new Uint8Array(o),c=new Uint8Array(r.length+n.length);return c.set(r),c.set(n,r.length),btoa(String.fromCharCode(...c))}catch(t){console.log("encryptData failed",t);try{return JSON.stringify(e)}catch(e){}}},n=async(e,t)=>{try{const r=Uint8Array.from(atob(e),e=>e.charCodeAt(0)),a=r.slice(0,12),o=r.slice(12),n=await crypto.subtle.decrypt({name:"AES-GCM",iv:a},t,o);return JSON.parse((new TextDecoder).decode(n))}catch(e){console.log("decryptData failed",e)}};t.cryptoKey=async e=>{try{if(!e)return;const t=await crypto.subtle.importKey("raw",(new TextEncoder).encode(e),"PBKDF2",!1,["deriveKey"]);return await crypto.subtle.deriveKey({name:"PBKDF2",salt:(new TextEncoder).encode("salt"),iterations:1e5,hash:"SHA-256"},t,{name:"AES-GCM",length:256},!1,["encrypt","decrypt"])}catch(e){console.log("processKey failed",e)}},t.encryptData=o,t.decryptData=n,t.encrypt=async e=>{try{const{ENCRYPTION_KEY:t}=(0,a.getConfig)();return t?await o(e,t):JSON.stringify(e)}catch(t){console.log("encrypt failed",t);try{return JSON.stringify(e)}catch(e){}}},t.decrypt=async e=>{try{const{ENCRYPTION_KEY:t}=(0,a.getConfig)();return t?await n(e,t):JSON.parse(e)}catch(e){console.log("decrypt failed",e)}}},247:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.readSecure=t.saveSecure=void 0;const a=r(28),o=r(896),n=r(205);t.saveSecure=async({key:e,data:t})=>{try{const{DB_NAME:r,STORE_NAME:c}=(0,a.getConfig)();return await(0,o.saveDB)({key:e,data:t?await(0,n.encrypt)(t):void 0,dbName:r,storeName:c})}catch(e){console.log("saveSecure failed",e)}return!1},t.readSecure=async e=>{try{const{DB_NAME:t,STORE_NAME:r}=(0,a.getConfig)(),c=await(0,o.readDB)({key:e,dbName:t,storeName:r});return c?await(0,n.decrypt)(c):void 0}catch(e){console.log("readSecure failed",e)}}},421:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.readData=t.saveData=void 0;t.saveData=({key:e,data:t})=>{try{void 0===t?localStorage.removeItem(e):localStorage.setItem(e,JSON.stringify(t))}catch(e){console.log("saveData failed",e)}},t.readData=e=>{try{const t=localStorage.getItem(e);return t?JSON.parse(t):void 0}catch(e){console.log("readData failed",e)}}},896:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.readDB=t.saveDB=t.openDB=void 0;const a=r(28),o=({dbName:e,storeName:t,version:r=1}={})=>new Promise((o,n)=>{e=e||(0,a.getConfig)().DB_NAME;const c=indexedDB.open(e,r);c.onupgradeneeded=()=>{t=t||(0,a.getConfig)().STORE_NAME;const e=c.result;e.objectStoreNames.contains(t)||e.createObjectStore(t,{keyPath:"id"})},c.onsuccess=()=>o(c.result),c.onerror=()=>{console.log("openDB failed",c.error),n(c.error)}});t.openDB=o,t.saveDB=async({key:e,data:t,dbName:r,storeName:a})=>{try{const n=await o({dbName:r,storeName:a});return new Promise(r=>{const o=n.transaction([a],"readwrite").objectStore(a),c=t?o.put({id:e,data:t}):o.delete(e);c.onsuccess=()=>r(!0),c.onerror=()=>{console.log("saveDB error",c.error),r(!1)},n.close()})}catch(e){console.log("saveSecure failed",e)}return!1},t.readDB=async({key:e,dbName:t,storeName:r})=>{try{const a=await o({dbName:t,storeName:r});return new Promise(t=>{const o=a.transaction([r],"readonly").objectStore(r).get(e);o.onsuccess=()=>t(o?.result?.data),o.onerror=()=>{console.log("readDB error",o.error),t(void 0)},a.close()})}catch(e){console.log("readDB failed",e)}}}},t={};function r(a){var o=t[a];if(void 0!==o)return o.exports;var n=t[a]={exports:{}};return e[a](n,n.exports,r),n.exports}var a={};return(()=>{var e=a;Object.defineProperty(e,"__esModule",{value:!0}),e.decryptData=e.encryptData=e.saveData=e.readData=e.saveSecure=e.readSecure=e.migrateSecure=e.getConfig=e.configureStorage=void 0;const t=r(421);Object.defineProperty(e,"readData",{enumerable:!0,get:function(){return t.readData}}),Object.defineProperty(e,"saveData",{enumerable:!0,get:function(){return t.saveData}});const o=r(28);Object.defineProperty(e,"configureStorage",{enumerable:!0,get:function(){return o.configureStorage}}),Object.defineProperty(e,"getConfig",{enumerable:!0,get:function(){return o.getConfig}}),Object.defineProperty(e,"migrateSecure",{enumerable:!0,get:function(){return o.migrateSecure}});const n=r(247);Object.defineProperty(e,"readSecure",{enumerable:!0,get:function(){return n.readSecure}}),Object.defineProperty(e,"saveSecure",{enumerable:!0,get:function(){return n.saveSecure}});const c=r(205);Object.defineProperty(e,"decryptData",{enumerable:!0,get:function(){return c.decryptData}}),Object.defineProperty(e,"encryptData",{enumerable:!0,get:function(){return c.encryptData}})})(),a})());
package/dist/config.d.ts CHANGED
@@ -1,10 +1,14 @@
1
1
  import { ConfigParams, MigrationParams } from "./types";
2
- declare let STORAGE_KEY: string, DB_NAME: string, STORE_NAME: string, ENCRYPTION_KEY: CryptoKey | undefined;
3
2
  declare const
4
- /** Initialize configurable variables from localStorage on start */
5
- initialiseConfig: () => Promise<void>,
6
3
  /** Configure Storage System */
7
4
  configureStorage: ({ storageKey, dbName, storeName, encryptionKey }: ConfigParams) => Promise<void>,
5
+ /** Get Configuration */
6
+ getConfig: () => {
7
+ STORAGE_KEY: string;
8
+ DB_NAME: string;
9
+ STORE_NAME: string;
10
+ ENCRYPTION_KEY: CryptoKey | undefined;
11
+ },
8
12
  /** Migrate Data */
9
13
  migrateSecure: ({ storedKeys, newEncryptionKey, newDbName, newStoreName, }: MigrationParams) => Promise<void>;
10
- export { STORAGE_KEY, DB_NAME, STORE_NAME, ENCRYPTION_KEY, initialiseConfig, configureStorage, migrateSecure, };
14
+ export { configureStorage, getConfig, migrateSecure, };
package/dist/db.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ import { DBConfig, DBRead, DBSave } from "./types";
2
+ declare const
3
+ /** Database (IndexedDB) operations */
4
+ openDB: ({ dbName, storeName, version }?: DBConfig) => Promise<IDBDatabase>,
5
+ /** Save Database (uses IndexedDB)*/
6
+ saveDB: ({ key, data, dbName, storeName, }: DBSave) => Promise<boolean>,
7
+ /** Read Database (uses IndexedDB)*/
8
+ readDB: ({ key, dbName, storeName, }: DBRead) => Promise<string | undefined>;
9
+ export { openDB, saveDB, readDB, };
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { readData, saveData } from "./storage";
2
- import { configureStorage, initialiseConfig, migrateSecure } from "./config";
2
+ import { configureStorage, getConfig, migrateSecure } from "./config";
3
3
  import { readSecure, saveSecure } from "./secure";
4
4
  import { StorageParams, ConfigParams } from "./types";
5
5
  import { decryptData, encryptData } from "./encrypt";
6
- export { StorageParams, ConfigParams, initialiseConfig, configureStorage, migrateSecure, readSecure, saveSecure, readData, saveData, encryptData, decryptData, };
6
+ export { StorageParams, ConfigParams, configureStorage, getConfig, migrateSecure, readSecure, saveSecure, readData, saveData, encryptData, decryptData, };
@@ -0,0 +1,7 @@
1
+ import { StorageParams } from "./types";
2
+ declare const
3
+ /** Save Large Data (uses IndexedDB)*/
4
+ saveLarge: <T>({ key, data }: StorageParams<T>) => Promise<boolean>,
5
+ /** Read Large Data (uses IndexedDB)*/
6
+ readLarge: <T>(key: string) => Promise<T | undefined>;
7
+ export { saveLarge, readLarge, };
@@ -1,2 +1,2 @@
1
1
  /*! For license information please see degreesign.node.min.js.LICENSE.txt */
2
- (()=>{"use strict";var e={28:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.migrateSecure=t.configureStorage=t.initialiseConfig=t.ENCRYPTION_KEY=t.STORE_NAME=t.DB_NAME=t.STORAGE_KEY=void 0;const a=r(205),o=r(247);let n,c="appData",i="appDB",s="appStorage";t.STORAGE_KEY=c,t.DB_NAME=i,t.STORE_NAME=s;const d="appConfig",y=async()=>{try{const e=localStorage.getItem(d);if(e){const r=JSON.parse(e);t.STORAGE_KEY=c=r.storageKey,t.DB_NAME=i=r.dbName||i,t.STORE_NAME=s=r.storeName||s,t.ENCRYPTION_KEY=n=r.encryptionKey?await(0,a.cryptoKey)(r.encryptionKey):void 0}}catch(e){console.log("initialiseConfig failed",e)}};t.initialiseConfig=y,t.configureStorage=async({storageKey:e,dbName:r,storeName:o,encryptionKey:y})=>{try{const l=localStorage.getItem(d);let u;l&&(u=JSON.parse(l));const g={storageKey:e,dbName:r||i,storeName:o||s,encryptionKey:y};localStorage.setItem(d,JSON.stringify(g)),t.STORAGE_KEY=c=e,g.dbName&&(t.DB_NAME=i=g.dbName),g.storeName&&(t.STORE_NAME=s=g.storeName),t.ENCRYPTION_KEY=n=y?await(0,a.cryptoKey)(y):void 0}catch(e){console.log("Error in configureStorage:",e)}},t.migrateSecure=async({storedKeys:e,newEncryptionKey:r,newDbName:c,newStoreName:d})=>{console.log("Data migration started...");const y=n,l=i,u=s;t.ENCRYPTION_KEY=n=await(0,a.cryptoKey)(r)??n,t.DB_NAME=i=c??i,t.STORE_NAME=s=d??s;for(let t=0;t<e.length;t++){const r=e[t];try{const e=await(0,o.readDB)({key:r,dbName:l,storeName:u}),t=e?y?await(0,a.decryptData)(e,y):JSON.parse(e):void 0,c=t?n?await(0,a.encryptData)(t,n):JSON.stringify(t):void 0;c&&await(0,o.saveDB)({key:r,data:c,dbName:i,storeName:s})}catch(e){console.log("migrateSecure failed",r,e)}}console.log("Data migration finished!")},y()},205:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.decrypt=t.encrypt=t.decryptData=t.encryptData=t.cryptoKey=void 0;const a=r(28),o=async(e,t)=>{try{const r=crypto.getRandomValues(new Uint8Array(12)),a=(new TextEncoder).encode(JSON.stringify(e)),o=await crypto.subtle.encrypt({name:"AES-GCM",iv:r},t,a),n=new Uint8Array(o),c=new Uint8Array(r.length+n.length);return c.set(r),c.set(n,r.length),btoa(String.fromCharCode(...c))}catch(t){console.log("encryptData failed",t);try{return JSON.stringify(e)}catch(e){}}},n=async(e,t)=>{try{const r=Uint8Array.from(atob(e),e=>e.charCodeAt(0)),a=r.slice(0,12),o=r.slice(12),n=await crypto.subtle.decrypt({name:"AES-GCM",iv:a},t,o);return JSON.parse((new TextDecoder).decode(n))}catch(e){return void console.log("decryptData failed",e)}};t.cryptoKey=async e=>{try{if(!e)return;const t=await crypto.subtle.importKey("raw",(new TextEncoder).encode(e),"PBKDF2",!1,["deriveKey"]);return await crypto.subtle.deriveKey({name:"PBKDF2",salt:(new TextEncoder).encode("salt"),iterations:1e5,hash:"SHA-256"},t,{name:"AES-GCM",length:256},!1,["encrypt","decrypt"])}catch(e){console.log("processKey failed",e)}},t.encryptData=o,t.decryptData=n,t.encrypt=async e=>{try{return a.ENCRYPTION_KEY?await o(e,a.ENCRYPTION_KEY):JSON.stringify(e)}catch(t){console.log("encrypt failed",t);try{return JSON.stringify(e)}catch(e){}}},t.decrypt=async e=>{try{return a.ENCRYPTION_KEY?await n(e,a.ENCRYPTION_KEY):JSON.parse(e)}catch(e){return void console.log("decrypt failed",e)}}},247:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.readSecure=t.saveSecure=t.readDB=t.saveDB=t.openDB=void 0;const a=r(28),o=r(205),n=({dbName:e,storeName:t,version:r=1}={})=>new Promise((o,n)=>{e=e||a.DB_NAME;const c=indexedDB.open(e,r);c.onupgradeneeded=()=>{t=t||a.STORE_NAME;const e=c.result;e.objectStoreNames.contains(t)||e.createObjectStore(t,{keyPath:"id"})},c.onsuccess=()=>o(c.result),c.onerror=()=>{console.log("openDB error",c.error),n(c.error)}}),c=async({key:e,data:t,dbName:r,storeName:a})=>{try{const o=await n({dbName:r,storeName:a});return new Promise(r=>{const n=o.transaction([a],"readwrite").objectStore(a),c=t?n.put({id:e,data:t}):n.delete(e);c.onsuccess=()=>r(!0),c.onerror=()=>{console.log("saveDB error",c.error),r(!1)},o.close()})}catch(e){return console.log("saveSecure failed",e),!1}},i=async({key:e,dbName:t,storeName:r})=>{try{const a=await n({dbName:t,storeName:r});return new Promise(t=>{const o=a.transaction([r],"readonly").objectStore(r).get(e);o.onsuccess=()=>t(o?.result?.data),o.onerror=()=>{console.log("readDB error",o.error),t(void 0)},a.close()})}catch(e){return void console.log("readDB failed",e)}};t.openDB=n,t.saveDB=c,t.readDB=i,t.saveSecure=async({key:e,data:t})=>await c({key:e,data:t?await(0,o.encrypt)(t):void 0,dbName:a.DB_NAME,storeName:a.STORE_NAME}),t.readSecure=async e=>{try{const t=await i({key:e,dbName:a.DB_NAME,storeName:a.STORE_NAME});return t?await(0,o.decrypt)(t):void 0}catch(e){return void console.log("readSecure failed",e)}}},421:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.readData=t.saveData=void 0;t.saveData=({key:e,data:t})=>{try{void 0===t?localStorage.removeItem(e):localStorage.setItem(e,JSON.stringify(t))}catch(e){console.log("saveData failed",e)}},t.readData=e=>{try{const t=localStorage.getItem(e);return t?JSON.parse(t):void 0}catch(e){return void console.log("readData failed",e)}}}},t={};function r(a){var o=t[a];if(void 0!==o)return o.exports;var n=t[a]={exports:{}};return e[a](n,n.exports,r),n.exports}var a={};(()=>{var e=a;Object.defineProperty(e,"__esModule",{value:!0}),e.decryptData=e.encryptData=e.saveData=e.readData=e.saveSecure=e.readSecure=e.migrateSecure=e.configureStorage=e.initialiseConfig=void 0;const t=r(421);Object.defineProperty(e,"readData",{enumerable:!0,get:function(){return t.readData}}),Object.defineProperty(e,"saveData",{enumerable:!0,get:function(){return t.saveData}});const o=r(28);Object.defineProperty(e,"configureStorage",{enumerable:!0,get:function(){return o.configureStorage}}),Object.defineProperty(e,"initialiseConfig",{enumerable:!0,get:function(){return o.initialiseConfig}}),Object.defineProperty(e,"migrateSecure",{enumerable:!0,get:function(){return o.migrateSecure}});const n=r(247);Object.defineProperty(e,"readSecure",{enumerable:!0,get:function(){return n.readSecure}}),Object.defineProperty(e,"saveSecure",{enumerable:!0,get:function(){return n.saveSecure}});const c=r(205);Object.defineProperty(e,"decryptData",{enumerable:!0,get:function(){return c.decryptData}}),Object.defineProperty(e,"encryptData",{enumerable:!0,get:function(){return c.encryptData}})})();var o=exports;for(var n in a)o[n]=a[n];a.__esModule&&Object.defineProperty(o,"__esModule",{value:!0})})();
2
+ (()=>{"use strict";var e={28:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.migrateSecure=t.getConfig=t.configureStorage=void 0;const a=r(896),o=r(205);let n,c="appData",s="appDB",i="appStorage";const d="appConfig";t.configureStorage=async({storageKey:e,dbName:t,storeName:r,encryptionKey:a})=>{try{await(async()=>{try{const e=localStorage.getItem(d);if(e){const t=JSON.parse(e);c=t.storageKey,s=t.dbName||s,i=t.storeName||i,n=t.encryptionKey?await(0,o.cryptoKey)(t.encryptionKey):void 0}}catch(e){console.log("initialiseConfig failed",e)}})();const y=localStorage.getItem(d);let l;y&&(l=JSON.parse(y));const g={storageKey:e,dbName:t||s,storeName:r||i,encryptionKey:a};localStorage.setItem(d,JSON.stringify(g)),c=e,g.dbName&&(s=g.dbName),g.storeName&&(i=g.storeName),n=a?await(0,o.cryptoKey)(a):void 0}catch(e){console.log("configureStorage failed",e)}},t.getConfig=()=>({STORAGE_KEY:c,DB_NAME:s,STORE_NAME:i,ENCRYPTION_KEY:n}),t.migrateSecure=async({storedKeys:e,newEncryptionKey:t,newDbName:r,newStoreName:c})=>{console.log("Data migration started...");const d=n,y=s,l=i;n=await(0,o.cryptoKey)(t)??n,s=r??s,i=c??i;for(let t=0;t<e.length;t++){const r=e[t];try{const e=await(0,a.readDB)({key:r,dbName:y,storeName:l}),t=e?d?await(0,o.decryptData)(e,d):JSON.parse(e):void 0,c=t?n?await(0,o.encryptData)(t,n):JSON.stringify(t):void 0;c&&await(0,a.saveDB)({key:r,data:c,dbName:s,storeName:i})}catch(e){console.log("migrateSecure failed",r,e)}}console.log("Data migration finished!")}},205:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.decrypt=t.encrypt=t.decryptData=t.encryptData=t.cryptoKey=void 0;const a=r(28),o=async(e,t)=>{try{const r=crypto.getRandomValues(new Uint8Array(12)),a=(new TextEncoder).encode(JSON.stringify(e)),o=await crypto.subtle.encrypt({name:"AES-GCM",iv:r},t,a),n=new Uint8Array(o),c=new Uint8Array(r.length+n.length);return c.set(r),c.set(n,r.length),btoa(String.fromCharCode(...c))}catch(t){console.log("encryptData failed",t);try{return JSON.stringify(e)}catch(e){}}},n=async(e,t)=>{try{const r=Uint8Array.from(atob(e),e=>e.charCodeAt(0)),a=r.slice(0,12),o=r.slice(12),n=await crypto.subtle.decrypt({name:"AES-GCM",iv:a},t,o);return JSON.parse((new TextDecoder).decode(n))}catch(e){console.log("decryptData failed",e)}};t.cryptoKey=async e=>{try{if(!e)return;const t=await crypto.subtle.importKey("raw",(new TextEncoder).encode(e),"PBKDF2",!1,["deriveKey"]);return await crypto.subtle.deriveKey({name:"PBKDF2",salt:(new TextEncoder).encode("salt"),iterations:1e5,hash:"SHA-256"},t,{name:"AES-GCM",length:256},!1,["encrypt","decrypt"])}catch(e){console.log("processKey failed",e)}},t.encryptData=o,t.decryptData=n,t.encrypt=async e=>{try{const{ENCRYPTION_KEY:t}=(0,a.getConfig)();return t?await o(e,t):JSON.stringify(e)}catch(t){console.log("encrypt failed",t);try{return JSON.stringify(e)}catch(e){}}},t.decrypt=async e=>{try{const{ENCRYPTION_KEY:t}=(0,a.getConfig)();return t?await n(e,t):JSON.parse(e)}catch(e){console.log("decrypt failed",e)}}},247:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.readSecure=t.saveSecure=void 0;const a=r(28),o=r(896),n=r(205);t.saveSecure=async({key:e,data:t})=>{try{const{DB_NAME:r,STORE_NAME:c}=(0,a.getConfig)();return await(0,o.saveDB)({key:e,data:t?await(0,n.encrypt)(t):void 0,dbName:r,storeName:c})}catch(e){console.log("saveSecure failed",e)}return!1},t.readSecure=async e=>{try{const{DB_NAME:t,STORE_NAME:r}=(0,a.getConfig)(),c=await(0,o.readDB)({key:e,dbName:t,storeName:r});return c?await(0,n.decrypt)(c):void 0}catch(e){console.log("readSecure failed",e)}}},421:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.readData=t.saveData=void 0;t.saveData=({key:e,data:t})=>{try{void 0===t?localStorage.removeItem(e):localStorage.setItem(e,JSON.stringify(t))}catch(e){console.log("saveData failed",e)}},t.readData=e=>{try{const t=localStorage.getItem(e);return t?JSON.parse(t):void 0}catch(e){console.log("readData failed",e)}}},896:(e,t,r)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.readDB=t.saveDB=t.openDB=void 0;const a=r(28),o=({dbName:e,storeName:t,version:r=1}={})=>new Promise((o,n)=>{e=e||(0,a.getConfig)().DB_NAME;const c=indexedDB.open(e,r);c.onupgradeneeded=()=>{t=t||(0,a.getConfig)().STORE_NAME;const e=c.result;e.objectStoreNames.contains(t)||e.createObjectStore(t,{keyPath:"id"})},c.onsuccess=()=>o(c.result),c.onerror=()=>{console.log("openDB failed",c.error),n(c.error)}});t.openDB=o,t.saveDB=async({key:e,data:t,dbName:r,storeName:a})=>{try{const n=await o({dbName:r,storeName:a});return new Promise(r=>{const o=n.transaction([a],"readwrite").objectStore(a),c=t?o.put({id:e,data:t}):o.delete(e);c.onsuccess=()=>r(!0),c.onerror=()=>{console.log("saveDB error",c.error),r(!1)},n.close()})}catch(e){console.log("saveSecure failed",e)}return!1},t.readDB=async({key:e,dbName:t,storeName:r})=>{try{const a=await o({dbName:t,storeName:r});return new Promise(t=>{const o=a.transaction([r],"readonly").objectStore(r).get(e);o.onsuccess=()=>t(o?.result?.data),o.onerror=()=>{console.log("readDB error",o.error),t(void 0)},a.close()})}catch(e){console.log("readDB failed",e)}}}},t={};function r(a){var o=t[a];if(void 0!==o)return o.exports;var n=t[a]={exports:{}};return e[a](n,n.exports,r),n.exports}var a={};(()=>{var e=a;Object.defineProperty(e,"__esModule",{value:!0}),e.decryptData=e.encryptData=e.saveData=e.readData=e.saveSecure=e.readSecure=e.migrateSecure=e.getConfig=e.configureStorage=void 0;const t=r(421);Object.defineProperty(e,"readData",{enumerable:!0,get:function(){return t.readData}}),Object.defineProperty(e,"saveData",{enumerable:!0,get:function(){return t.saveData}});const o=r(28);Object.defineProperty(e,"configureStorage",{enumerable:!0,get:function(){return o.configureStorage}}),Object.defineProperty(e,"getConfig",{enumerable:!0,get:function(){return o.getConfig}}),Object.defineProperty(e,"migrateSecure",{enumerable:!0,get:function(){return o.migrateSecure}});const n=r(247);Object.defineProperty(e,"readSecure",{enumerable:!0,get:function(){return n.readSecure}}),Object.defineProperty(e,"saveSecure",{enumerable:!0,get:function(){return n.saveSecure}});const c=r(205);Object.defineProperty(e,"decryptData",{enumerable:!0,get:function(){return c.decryptData}}),Object.defineProperty(e,"encryptData",{enumerable:!0,get:function(){return c.encryptData}})})();var o=exports;for(var n in a)o[n]=a[n];a.__esModule&&Object.defineProperty(o,"__esModule",{value:!0})})();
package/dist/secure.d.ts CHANGED
@@ -1,13 +1,7 @@
1
- import { DBConfig, DBRead, DBSave, StorageParams } from "./types";
1
+ import { StorageParams } from "./types";
2
2
  declare const
3
- /** Database (IndexedDB) operations */
4
- openDB: ({ dbName, storeName, version }?: DBConfig) => Promise<IDBDatabase>,
5
- /** Save Database (uses IndexedDB)*/
6
- saveDB: ({ key, data, dbName, storeName, }: DBSave) => Promise<boolean>,
7
- /** Read Database (uses IndexedDB)*/
8
- readDB: ({ key, dbName, storeName, }: DBRead) => Promise<string | undefined>,
9
3
  /** Save Secure Data (uses IndexedDB)*/
10
4
  saveSecure: <T>({ key, data }: StorageParams<T>) => Promise<boolean>,
11
5
  /** Read Secure Data (uses IndexedDB)*/
12
6
  readSecure: <T>(key: string) => Promise<T | undefined>;
13
- export { openDB, saveDB, readDB, saveSecure, readSecure, };
7
+ export { saveSecure, readSecure, };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@degreesign/storage",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "DegreeSign Storage System",
5
5
  "main": "dist/node/degreesign.node.min.js",
6
6
  "module": "dist/node/degreesign.node.min.js",