v2.0.0

* Added new function getKeys() * Changed loadPrivatekey and savePrivatekey methods to static functions * Updated README.md and package.json version * Updated localforage * Added setConfig and getConfig
randlabs · Oct 9, 2020 · 041ecc1 · 041ecc1
1 parent c861c77
commit 041ecc1
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 85 deletions.
diff --git a/README.md b/README.md
@@ -104,9 +104,8 @@ const password = "secret-password";
 const itemKey = "private_key";
 const privateData = "private key information";
 (async () => {
-    const appStorage = new AppStorage(obfuscatekey);
     const data = new Uint8Array(Buffer.from(privateData));
-    await appStorage.savePrivatekeyToStorage(itemKey, password, data);
+    await AppStorage.savePrivatekeyToStorage(itemKey, password, data);
 })().catch(e => {
     console.log(e);
 });
@@ -119,8 +118,7 @@ const password = "secret-password";
 const itemKey = "private_key";
 
 (async () => {
-    const appStorage = new AppStorage(obfuscatekey);
-    const data = await appStorage.loadPrivatekeyFromStorage(itemKey, password, data);
+    const data = await AppStorage.loadPrivatekeyFromStorage(itemKey, password, data);
     console.log(Buffer.from(data).toString());
 })().catch(e => {
     console.log(e);

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@randlabs/encrypted-local-storage",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -47,6 +47,6 @@
     "typescript": "^3.9.3"
   },
   "dependencies": {
-    "localforage": "^1.7.4"
+    "localforage": "^1.9.0"
   }
 }
diff --git a/src/index.ts b/src/index.ts
@@ -37,13 +37,13 @@ export default class AppStorage {
 	}
 
 	// Private key storage
-	async savePrivatekeyToStorage(key: string, password: string, pk: Uint8Array): Promise<void> {
+	static async savePrivatekeyToStorage(key: string, password: string, pk: Uint8Array): Promise<void> {
 		const masterkey = await StrongCipher.generateMasterKey(password);
 		const encryptedPk = await StrongCipher.encrypt(toHexString(pk), masterkey);
 		await AppStorage.setItem(key, encryptedPk);
 	}
 
-	async loadPrivatekeyFromStorage(key: string, password: string): Promise<Uint8Array> {
+	static async loadPrivatekeyFromStorage(key: string, password: string): Promise<Uint8Array> {
 		const masterkey = await StrongCipher.generateMasterKey(password);
 		const encryptedPk = await AppStorage.getItem(key);
 		if (!encryptedPk) {
@@ -115,6 +115,10 @@ export default class AppStorage {
 		return hasItem;
 	}
 
+	static getKeys(): Promise<string[]> {
+		return Storage.getKeys();
+	}
+
 	static async resetStorage(): Promise<void> {
 		await Storage.clearStorage();
 	}

diff --git a/src/storage.ts b/src/storage.ts
@@ -27,4 +27,20 @@ export default class Storage {
 
 		return ret !== null;
 	}
+
+	static getKeys(): Promise<string[]> {
+		return localforage.keys();
+	}
+
+	static setConfig(config: LocalForageOptions): void {
+		localforage.config(config);
+	}
+
+	static getConfig(): LocalForageOptions {
+		return localforage.config();
+	}
+
+	static setDriver(driver: string | string[]): void {
+		localforage.setDriver(driver);
+	}
 }
diff --git a/src/test/test-strong-store.ts b/src/test/test-strong-store.ts
@@ -8,13 +8,7 @@ describe("Strong Store Management", function() {
 	const secretItem = "Item to store";
 
 	before(function(done) {
-		AppStorage.createPassword(masterkey, password)
-		.then(() => {
-			done();
-		})
-		.catch((err) => {
-			done(err);
-		});
+		AppStorage.createPassword(masterkey, password).then(done).catch(done);
 	});
 
 	describe("Save string to the storage", function() {
@@ -23,31 +17,23 @@ describe("Strong Store Management", function() {
 			AppStorage.verifyPassword(masterkey, password)
 			.then((result) => {
 				done();
-			})
-			.catch((err) => {
-				done(err);
-			});
+			}).catch(done);
 		});
 
 		it("Should save the item", function(done) {
-			const storage = new AppStorage();
-			storage.savePrivatekeyToStorage(secretKey, password, new Uint8Array(Buffer.from(secretItem)))
+			AppStorage.savePrivatekeyToStorage(secretKey, password, new Uint8Array(Buffer.from(secretItem)))
 			.then(() => {
 				done();
-			})
-			.catch((err) => {
-				done(err);
-			});
+			}).catch(done);
 		});
 
 	});
 
 	describe("Load string from the storage with a invalid password", function() {
 
 		it("Should throw error by load item with a wrong password", function(done) {
-			const storage = new AppStorage();
-			storage.loadPrivatekeyFromStorage(secretKey, "wrong password")
-			.then((storedItem) => {
+			AppStorage.loadPrivatekeyFromStorage(secretKey, "wrong password")
+			.then(() => {
 				done("Invalid test, must fail");
 			})
 			.catch((err) => {
@@ -64,29 +50,20 @@ describe("Strong Store Management", function() {
 			AppStorage.verifyPassword(masterkey, password)
 			.then((result) => {
 				done();
-			})
-			.catch((err) => {
-				done(err);
-			});
+			}).catch(done);
 		});
 
 		it("Should load the item", function(done) {
-			const storage = new AppStorage();
-			storage.loadPrivatekeyFromStorage(secretKey, password)
+			AppStorage.loadPrivatekeyFromStorage(secretKey, password)
 			.then((storedItem) => {
 				const item = (Buffer.from(storedItem)).toString();
 				expect(item).to.be.equal(secretItem);
 				done();
-			})
-			.catch((err) => {
-				done(err);
-			});
+			}).catch(done);
 		});
 
 		after(function(done) {
-			AppStorage.removeItem(secretKey).then(() => {
-				done();
-			});
+			AppStorage.removeItem(secretKey).then(done).catch(done);
 		});
 
 	});
@@ -96,15 +73,11 @@ describe("Strong Store Management", function() {
 			AppStorage.verifyPassword(masterkey, password)
 			.then((result) => {
 				done();
-			})
-			.catch((err) => {
-				done(err);
-			});
+			}).catch(done)
 		});
 
 		it("Should load the item", function(done) {
-			const storage = new AppStorage();
-			storage.loadPrivatekeyFromStorage(secretKey, password)
+			AppStorage.loadPrivatekeyFromStorage(secretKey, password)
 			.then(() => {
 				done("Invalid test, must fail");
 			})
@@ -117,8 +90,6 @@ describe("Strong Store Management", function() {
 	});
 
 	after(function(done) {
-		AppStorage.resetStorage().then(() => {
-			done();
-		});
+		AppStorage.resetStorage().then(done).catch(done);
 	});
 });
diff --git a/src/test/test.ts b/src/test/test.ts
@@ -7,79 +7,57 @@ describe("Test utils functions", function() {
 	const itemToStore = "item";
 
 	it("Should save a string", function(done) {
-		AppStorage.setItem(itemKey, itemToStore)
-		.then(() => {
-			done();
-		})
-		.catch((err) => {
-			done(err);
-		});
+		AppStorage.setItem(itemKey, itemToStore).catch(done).then(done);
 	});
 
 	it("Should load a string", function(done) {
-		AppStorage.getItem(itemKey)
+		AppStorage.getItem(itemKey).catch(done)
 		.then((storedItem) => {
 			expect(storedItem).to.be.equal(itemToStore);
 			done();
-		})
-		.catch((err) => {
-			done(err);
 		});
 	});
 
 	it("Should not load a string", function(done) {
-		AppStorage.getItem(itemKey + "1")
+		AppStorage.getItem(itemKey + "1").catch(done)
 		.then((storedItem) => {
 			expect(storedItem).to.be.equal(null);
 			done();
-		})
-		.catch((err) => {
-			done(err);
 		});
 	});
 
 	it("Should has an item", function(done) {
-		AppStorage.hasItem(itemKey)
+		AppStorage.hasItem(itemKey).catch(done)
 		.then((isStored) => {
 			expect(isStored).to.be.a("boolean");
 			expect(isStored).to.be.equal(true);
 			done();
-		})
-		.catch((err) => {
-			done(err);
 		});
 	});
 
 	it("Should not has an item", function(done) {
-		AppStorage.hasItem(itemKey + "1")
+		AppStorage.hasItem(itemKey + "1").catch(done)
 		.then((isStored) => {
 			expect(isStored).to.be.a("boolean");
 			expect(isStored).to.be.equal(false);
 			done();
-		})
-		.catch((err) => {
-			done(err);
 		});
 	});
 
 	it("Should remove an item", function(done) {
-		AppStorage.removeItem(itemKey)
-		.then(() => {
+		AppStorage.removeItem(itemKey).catch(done).then(done);
+	});
+
+	it("Should list all storage keys", function(done) {
+		AppStorage.getKeys().catch(done)
+		.then((keys) => {
+			expect(keys).to.be.an("array");
 			done();
-		})
-		.catch((err) => {
-			done(err);
 		});
 	});
 
 	it("Should reset the storage", function(done) {
-		AppStorage.resetStorage()
-		.then(() => {
-			done();
-		})
-		.catch((err) => {
-			done(err);
-		});
+		AppStorage.resetStorage().catch(done).then(done);
 	});
 
 });