1.0.13

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/webstore",
-  "version": "1.0.2",
+  "version": "1.0.13",
   "private": false,
   "description": "high performance storage in the browser using indexed db",
   "main": "dist_ts/index.js",
@@ -8,20 +8,20 @@
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "(tstest test/ --web)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)"
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.39",
+    "@gitzone/tstest": "^1.0.44",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^14.0.20",
+    "@types/node": "^14.11.1",
-    "tslint": "^6.1.2",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "idb": "^5.0.4"
+    "@pushrocks/smartpromise": "^3.0.6",
+    "idb": "^5.0.6"
   },
   "browserslist": [
     "last 1 chrome versions"

test/test.browser.ts

@@ -1,11 +1,44 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as webstore from '../ts/index';
 
-let testWebstore = new webstore.WebStore();
+let testWebstore: webstore.WebStore;
 
 tap.test('first test', async () => {
-  testWebstore = new webstore.WebStore();
+  testWebstore = new webstore.WebStore({
+    dbName: 'mytest-db',
+    storeName: 'mytest-store',
+  });
   expect(testWebstore).to.be.instanceOf(webstore.WebStore);
 });
 
+tap.test('should init the database', async () => {
+  await testWebstore.init();
+});
+
+tap.test('should allow storing a string', async () => {
+  await testWebstore.set('mystring', 'heythere');
+  expect(await testWebstore.get('mystring')).to.equal('heythere');
+});
+
+tap.test('should allow storing an object', async () => {
+  await testWebstore.set('testProp1', {
+    wow: 'wowVal',
+  });
+  console.log(JSON.stringify(await testWebstore.get('testProp1')));
+});
+
+tap.test('should overwrite a value', async () => {
+  await testWebstore.set('testProp1', {
+    wow: 'wowVal2',
+  });
+  console.log(JSON.stringify(await testWebstore.get('testProp1')));
+});
+
+tap.test('should correctly check the existence of keys', async () => {
+  const resultNotThere = await testWebstore.check('notThere');
+  const resultThere = await testWebstore.check('testProp1');
+  expect(resultNotThere).to.be.false;
+  expect(resultThere).to.be.true;
+});
+
 tap.start();

ts/index.ts

@@ -1 +1 @@
-export * from './webstiore.classes.webstore';
+export * from './webstore.classes.webstore';

ts/webstiore.classes.webstore.ts

@@ -1,5 +0,0 @@
-import * as plugins from './webstore.plugins';
-
-export class WebStore {
-  
-}

ts/webstore.classes.webstore.ts

@@ -0,0 +1,61 @@
+import * as plugins from './webstore.plugins';
+
+export interface IWebStoreOptions {
+  dbName: string;
+  storeName: string;
+}
+
+export class WebStore<T = any> {
+  public db: plugins.idb.IDBPDatabase;
+  public objectStore: plugins.idb.IDBPObjectStore;
+  public options: IWebStoreOptions;
+  private initCalled: boolean = false;
+  private readyDeferred = plugins.smartpromise.defer();
+
+  constructor(optionsArg: IWebStoreOptions) {
+    this.options = optionsArg;
+  }
+
+  public async init() {
+    if (this.initCalled) {
+      return this.readyDeferred.promise;
+    }
+    this.initCalled = true;
+    this.db = await plugins.idb.openDB(this.options.dbName, 1, {
+      upgrade: (db) => {
+        db.createObjectStore(this.options.storeName);
+      },
+    });
+    this.readyDeferred.resolve();
+  }
+
+  async get(key: string): Promise<T> {
+    await this.init();
+    return this.db.get(this.options.storeName, key);
+  }
+
+  async check(keyArg: string): Promise<boolean> {
+    await this.init();
+    const result = await this.get(keyArg);
+    return !!result;
+  }
+
+  async set(key: string, val: T) {
+    return this.db.put(this.options.storeName, val, key);
+  }
+
+  async delete(key: string) {
+    await this.init();
+    return this.db.delete(this.options.storeName, key);
+  }
+
+  async clear() {
+    await this.init();
+    return this.db.clear(this.options.storeName);
+  }
+
+  async keys() {
+    await this.init();
+    return this.db.getAllKeys(this.options.storeName);
+  }
+}

ts/webstore.plugins.ts

@@ -1,5 +1,11 @@
-import * as idb from 'idb';
+// pushrocks scope
+import * as smartpromise from '@pushrocks/smartpromise';
 
 export {
-  idb
+  smartpromise
-}
+};
+
+// thirdparty scope
+import * as idb from 'idb';
+
+export { idb };