4.0.23

.gitlab-ci.yml

@@ -12,6 +12,10 @@ stages:
   - release
   - metadata
 
+before_script:
+  - apt-get update && apt-get install -y libcurl3 libssl-dev openssl libssl1.0.0 mongodb
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -36,6 +40,7 @@ auditProductionDependencies:
     - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartdata",
-  "version": "4.0.13",
+  "version": "4.0.23",
   "private": false,
   "description": "do more with data",
   "main": "dist_ts/index.js",
@@ -21,27 +21,27 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartdata#README",
   "dependencies": {
-    "@pushrocks/lik": "^4.0.20",
-    "@pushrocks/smartlog": "^2.0.39",
+    "@pushrocks/lik": "^5.0.0",
+    "@pushrocks/smartlog": "^2.0.44",
     "@pushrocks/smartpromise": "^3.1.5",
     "@pushrocks/smartstring": "^3.0.24",
     "@pushrocks/smartunique": "^3.0.3",
-    "@tsclass/tsclass": "^3.0.33",
-    "@types/lodash": "^4.14.169",
-    "@types/mongodb": "^3.6.12",
+    "@tsclass/tsclass": "^3.0.36",
+    "@types/lodash": "^4.14.176",
+    "@types/mongodb": "^4.0.7",
     "lodash": "^4.17.21",
-    "mongodb": "^3.6.6",
+    "mongodb": "^4.1.4",
     "runtime-type-checks": "0.0.4"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.54",
+    "@gitzone/tsbuild": "^2.1.28",
+    "@gitzone/tstest": "^1.0.60",
     "@pushrocks/qenv": "^4.0.10",
     "@pushrocks/tapbundle": "^3.2.14",
     "@types/mongodb-memory-server": "^2.3.0",
-    "@types/node": "^15.3.0",
+    "@types/node": "^16.11.7",
     "@types/shortid": "0.0.29",
-    "mongodb-memory-server": "^6.9.6",
+    "mongodb-memory-server": "^8.0.2",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },

readme.md

@@ -90,7 +90,7 @@ class MyObject extends smartdata.DbDoc<MyObject /* ,[an optional interface to im
 const localObject = new MyObject({
   property1: 'hi',
   property2: {
-    deep: 3
+    deep: 3,
   },
 });
 await localObject.save(); // saves the object to the database
@@ -102,9 +102,9 @@ const myInstance = await MyObject.getInstance({
   property1: 'hi',
   property2: {
     deep: {
-      $gt: 2
-    } as any
-  }
+      $gt: 2,
+    } as any,
+  },
 }); // outputs a new instance of MyObject with the values from db assigned
 ```
 

test/test.easystore.ts

@@ -0,0 +1,64 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+import { Qenv } from '@pushrocks/qenv';
+
+const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/');
+
+console.log(process.memoryUsage());
+
+// the tested module
+import * as smartdata from '../ts/index';
+
+import * as mongoPlugin from 'mongodb-memory-server';
+import { smartunique } from '../ts/smartdata.plugins';
+
+// =======================================
+// Connecting to the database server
+// =======================================
+
+let testDb: smartdata.SmartdataDb;
+let smartdataOptions: smartdata.IMongoDescriptor;
+let mongod: mongoPlugin.MongoMemoryServer;
+
+tap.skip.test('should create a testinstance as database', async () => {
+  mongod = await mongoPlugin.MongoMemoryServer.create();
+  console.log('created mongod instance');
+  console.log('mongod started');
+  smartdataOptions = {
+    mongoDbUrl: mongod.getUri(),
+  };
+  console.log(smartdataOptions);
+  testDb = new smartdata.SmartdataDb(smartdataOptions);
+  await testDb.init();
+});
+
+tap.test('should connect to atlas', async (tools) => {
+  const databaseName = `test-smartdata-${smartunique.shortId()}`;
+  testDb = new smartdata.SmartdataDb({
+    mongoDbUrl: testQenv.getEnvVarOnDemand('MONGO_URL'),
+    mongoDbName: databaseName,
+  });
+  await testDb.init();
+});
+
+let easyStore: smartdata.EasyStore<{
+  key1: string;
+  key2: string;
+}>;
+
+tap.test('should create an easystore', async () => {
+  easyStore = await testDb.createEasyStore('hellothere');
+  await easyStore.writeKey('key1', 'hello');
+  const retrievedKey = await easyStore.readKey('key1');
+  expect(retrievedKey).to.equal('hello');
+});
+
+tap.test('close', async () => {
+  if (mongod) {
+    await mongod.stop();
+  } else {
+    await testDb.mongoDb.dropDatabase();
+  }
+  await testDb.close();
+});
+
+tap.start();

test/test.ts

@@ -22,19 +22,15 @@ let mongod: mongoPlugin.MongoMemoryServer;
 const totalCars = 2000;
 
 tap.skip.test('should create a testinstance as database', async () => {
-  mongod = new mongoPlugin.MongoMemoryServer({});
+  mongod = await mongoPlugin.MongoMemoryServer.create();
   console.log('created mongod instance');
-  await mongod._startUpInstance().catch((err) => {
-    console.log(err);
-  });
   console.log('mongod started');
   smartdataOptions = {
-    mongoDbName: await mongod.getDbName(),
-    mongoDbPass: '',
-    mongoDbUrl: await mongod.getUri(),
+    mongoDbUrl: mongod.getUri(),
   };
   console.log(smartdataOptions);
   testDb = new smartdata.SmartdataDb(smartdataOptions);
+  await testDb.init();
 });
 
 tap.test('should connect to atlas', async (tools) => {
@@ -43,9 +39,6 @@ tap.test('should connect to atlas', async (tools) => {
     mongoDbUrl: testQenv.getEnvVarOnDemand('MONGO_URL'),
     mongoDbName: databaseName,
   });
-});
-
-tap.test('should establish a connection to mongod', async () => {
   await testDb.init();
 });
 
@@ -134,7 +127,7 @@ tap.test('expect to get instance of Car with deep match', async () => {
     const timeStart = Date.now();
     const myCars2 = await Car.getInstances({
       deepData: {
-        sodeep: 'yes'
+        sodeep: 'yes',
       },
     });
     if (counter % 10 === 0) {
@@ -200,24 +193,30 @@ class Truck extends smartdata.SmartDataDbDoc<Car, Car> {
 tap.test('should store a new Truck', async () => {
   const truck = new Truck('blue', 'MAN');
   await truck.save();
-  const myTruck = await Truck.getInstance({ color: 'blue' });
-  myTruck.id = 'foo';
-  await myTruck.save();
   const myTruck2 = await Truck.getInstance({ color: 'blue' });
-  console.log(myTruck2);
+  myTruck2.color = 'red';
+  await myTruck2.save();
+  const myTruck3 = await Truck.getInstance({ color: 'blue' });
+  console.log(myTruck3);
 });
 
-tap.test('should ', async () => {})
+tap.test('should use a cursor', async () => {
+  const cursor = await Truck.getCursor({});
+  cursor.forEach(async truckArg => {
+    console.log(truckArg.id);
+  });
+});
 
 // =======================================
 // close the database connection
 // =======================================
-tap.test('should close the database connection', async (tools) => {
-  await testDb.mongoDb.dropDatabase();
-  await testDb.close();
-  try {
+tap.test('close', async () => {
+  if (mongod) {
     await mongod.stop();
-  } catch (e) {}
+  } else {
+    await testDb.mongoDb.dropDatabase();
+  }
+  await testDb.close();
 });
 
 tap.start({ throwOnError: true });

test/test.typescript.ts

@@ -22,19 +22,15 @@ let mongod: mongoPlugin.MongoMemoryServer;
 const totalCars = 2000;
 
 tap.skip.test('should create a testinstance as database', async () => {
-  mongod = new mongoPlugin.MongoMemoryServer({});
+  mongod = await mongoPlugin.MongoMemoryServer.create();
   console.log('created mongod instance');
-  await mongod._startUpInstance().catch((err) => {
-    console.log(err);
-  });
   console.log('mongod started');
   smartdataOptions = {
-    mongoDbName: await mongod.getDbName(),
-    mongoDbPass: '',
-    mongoDbUrl: await mongod.getUri(),
+    mongoDbUrl: mongod.getUri(),
   };
   console.log(smartdataOptions);
   testDb = new smartdata.SmartdataDb(smartdataOptions);
+  await testDb.init();
 });
 
 tap.test('should connect to atlas', async (tools) => {
@@ -43,9 +39,6 @@ tap.test('should connect to atlas', async (tools) => {
     mongoDbUrl: testQenv.getEnvVarOnDemand('MONGO_URL'),
     mongoDbName: databaseName,
   });
-});
-
-tap.test('should establish a connection to mongod', async () => {
   await testDb.init();
 });
 
@@ -80,7 +73,7 @@ class Car extends smartdata.SmartDataDbDoc<Car, Car> {
 }
 
 const createCarClass = (dbArg: smartdata.SmartdataDb) => {
-  smartdata.setDefaultManagerForDoc({db: dbArg}, Car);
+  smartdata.setDefaultManagerForDoc({ db: dbArg }, Car);
   return Car;
 };
 
@@ -92,19 +85,20 @@ tap.test('should produce a car', async () => {
 
 tap.test('should get a car', async () => {
   const car = Car.getInstance({
-    color: 'red'
-  })
-})
+    color: 'red',
+  });
+});
 
 // =======================================
 // close the database connection
 // =======================================
-tap.test('should close the database connection', async (tools) => {
-  await testDb.mongoDb.dropDatabase();
-  await testDb.close();
-  try {
+tap.test('close', async () => {
+  if (mongod) {
     await mongod.stop();
-  } catch (e) {}
+  } else {
+    await testDb.mongoDb.dropDatabase();
+  }
+  await testDb.close();
 });
 
 tap.start({ throwOnError: true });

ts/index.ts

@@ -1,5 +1,6 @@
 export * from './smartdata.classes.db';
 export * from './smartdata.classes.collection';
 export * from './smartdata.classes.doc';
+export * from './smartdata.classes.easystore';
 
 export { IMongoDescriptor } from './interfaces';

ts/smartdata.classes.collection.ts

@@ -1,5 +1,6 @@
 import * as plugins from './smartdata.plugins';
 import { SmartdataDb } from './smartdata.classes.db';
+import { SmartdataDbCursor } from './smartdata.classes.cursor';
 import { SmartDataDbDoc } from './smartdata.classes.doc';
 import { CollectionFactory } from './smartdata.classes.collectionfactory';
 
@@ -42,19 +43,19 @@ export function Collection(dbArg: SmartdataDb | TDelayed<SmartdataDb>) {
 }
 
 export interface IManager {
-  db: SmartdataDb
+  db: SmartdataDb;
 }
 
-export const setDefaultManagerForDoc = <T>(managerArg: IManager,  dbDocArg: T): T => {
+export const setDefaultManagerForDoc = <T>(managerArg: IManager, dbDocArg: T): T => {
   (dbDocArg as any).prototype.defaultManager = managerArg;
   return dbDocArg;
-}
+};
 
 /**
  * This is a decorator that will tell the decorated class what dbTable to use
  * @param dbArg
  */
- export function Manager<TManager extends IManager>(managerArg?: TManager | TDelayed<TManager>) {
+export function Manager<TManager extends IManager>(managerArg?: TManager | TDelayed<TManager>) {
   return function classDecorator<T extends { new (...args: any[]): any }>(constructor: T) {
     return class extends constructor {
       public static get collection() {
@@ -62,7 +63,7 @@ export const setDefaultManagerForDoc = <T>(managerArg: IManager,  dbDocArg: T):
         if (!managerArg) {
           dbArg = this.prototype.defaultManager.db;
         } else if (managerArg['db']) {
-          dbArg = (managerArg as TManager).db
+          dbArg = (managerArg as TManager).db;
         } else {
           dbArg = (managerArg as TDelayed<TManager>)().db;
         }
@@ -75,7 +76,7 @@ export const setDefaultManagerForDoc = <T>(managerArg: IManager,  dbDocArg: T):
           //process.exit(0)
           dbArg = this.defaultManager.db;
         } else if (managerArg['db']) {
-          dbArg = (managerArg as TManager).db
+          dbArg = (managerArg as TManager).db;
         } else {
           dbArg = (managerArg as TDelayed<TManager>)().db;
         }
@@ -83,8 +84,10 @@ export const setDefaultManagerForDoc = <T>(managerArg: IManager,  dbDocArg: T):
       }
       public static get manager() {
         let manager: TManager;
-        if (managerArg['db']) {
-          manager = (managerArg as TManager);
+        if (!managerArg) {
+          manager = this.prototype.defaultManager
+        } else if (managerArg['db']) {
+          manager = managerArg as TManager;
         } else {
           manager = (managerArg as TDelayed<TManager>)();
         }
@@ -92,8 +95,10 @@ export const setDefaultManagerForDoc = <T>(managerArg: IManager,  dbDocArg: T):
       }
       public get manager() {
         let manager: TManager;
-        if (managerArg['db']) {
-          manager = (managerArg as TManager);
+        if (!managerArg) {
+          manager = this.defaultManager
+        } else if (managerArg['db']) {
+          manager = managerArg as TManager;
         } else {
           manager = (managerArg as TDelayed<TManager>)();
         }
@@ -166,9 +171,28 @@ export class SmartdataCollection<T> {
   /**
    * finds an object in the DbCollection
    */
-  public async find(filterObject: any): Promise<any> {
+   public async findOne(filterObject: any): Promise<any> {
     await this.init();
-    const result = await this.mongoDbCollection.find(filterObject).toArray();
+    const cursor = this.mongoDbCollection.find(filterObject);
+    const result = await cursor.next();
+    cursor.close();
+    return result;
+  }
+
+  public async getCursor(filterObject: any): Promise<SmartdataDbCursor<any>> {
+    await this.init();
+    const cursor = this.mongoDbCollection.find(filterObject);
+    return new SmartdataDbCursor(cursor);
+  }
+
+  /**
+   * finds an object in the DbCollection
+   */
+  public async findAll(filterObject: any): Promise<any[]> {
+    await this.init();
+    const cursor = this.mongoDbCollection.find(filterObject);
+    const result = await cursor.toArray();
+    cursor.close();
     return result;
   }
 
@@ -211,9 +235,7 @@ export class SmartdataCollection<T> {
     await this.init();
     await this.checkDoc(dbDocArg);
     const identifiableObject = await dbDocArg.createIdentifiableObject();
-    await this.mongoDbCollection.deleteOne(identifiableObject, {
-      w: 1,
-    });
+    await this.mongoDbCollection.deleteOne(identifiableObject);
   }
 
   /**

ts/smartdata.classes.collectionfactory.ts

@@ -5,10 +5,7 @@ import { SmartdataDb } from './smartdata.classes.db';
 export class CollectionFactory {
   public collections: { [key: string]: SmartdataCollection<any> } = {};
 
-  public getCollection = (
-    nameArg: string,
-    dbArg: SmartdataDb
-  ): SmartdataCollection<any> => {
+  public getCollection = (nameArg: string, dbArg: SmartdataDb): SmartdataCollection<any> => {
     if (!this.collections[nameArg]) {
       this.collections[nameArg] = (() => {
         if (dbArg instanceof SmartdataDb) {

ts/smartdata.classes.cursor.ts

@@ -0,0 +1,39 @@
+import * as plugins from './smartdata.plugins';
+
+/**
+ * a wrapper for the native mongodb cursor. Exposes better 
+ */
+export class SmartdataDbCursor<T = any> {
+  // STATIC
+
+  // INSTANCE
+  public mongodbCursor: plugins.mongodb.FindCursor<T>;
+  constructor(cursorArg: plugins.mongodb.FindCursor<T>) {
+    this.mongodbCursor = cursorArg
+  };
+
+  public async next(closeAtEnd = true) {
+    const result = await this.mongodbCursor.next();
+    if (!result && closeAtEnd) {
+      await this.close();
+    };
+    return result;
+  };
+
+  public async forEach(forEachFuncArg: (itemArg: T) => Promise<any>, closeCursorAtEnd = true) {
+    let currentValue: T;
+    do {
+      currentValue = await this.mongodbCursor.next();
+      if (currentValue) {
+        await forEachFuncArg(currentValue);
+      }
+    } while (currentValue);
+    if (closeCursorAtEnd) {
+      await this.close();
+    }
+  }
+
+  public async close() {
+    await this.mongodbCursor.close();
+  }
+}

ts/smartdata.classes.db.ts

@@ -2,6 +2,7 @@ import * as plugins from './smartdata.plugins';
 import { ObjectMap } from '@pushrocks/lik';
 
 import { SmartdataCollection } from './smartdata.classes.collection';
+import { EasyStore } from './smartdata.classes.easystore';
 
 import { logger } from './smartdata.logging';
 import { IMongoDescriptor } from './interfaces';
@@ -23,6 +24,12 @@ export class SmartdataDb {
     this.status = 'initial';
   }
 
+  // easystore
+  public async createEasyStore(nameIdArg: string) {
+    const easyStore = new EasyStore(nameIdArg, this);
+    return easyStore;
+  }
+
   // basic connection stuff ----------------------------------------------
 
   /**
@@ -40,8 +47,6 @@ export class SmartdataDb {
       .replace('<dbname>', this.smartdataOptions.mongoDbName);
 
     this.mongoDbClient = await plugins.mongodb.MongoClient.connect(finalConnectionUrl, {
-      useNewUrlParser: true,
-      useUnifiedTopology: true,
       maxPoolSize: 100,
       maxIdleTimeMS: 10,
     });
@@ -71,7 +76,7 @@ export class SmartdataDb {
    * @returns DbTable
    */
   public async getSmartdataCollectionByName<T>(nameArg: string): Promise<SmartdataCollection<T>> {
-    const resultCollection = this.smartdataCollectionMap.find((dbTableArg) => {
+    const resultCollection = await this.smartdataCollectionMap.find(async (dbTableArg) => {
       return dbTableArg.collectionName === nameArg;
     });
     return resultCollection;

ts/smartdata.classes.doc.ts

@@ -3,6 +3,7 @@ import * as plugins from './smartdata.plugins';
 import { ObjectMap } from '@pushrocks/lik';
 
 import { SmartdataDb } from './smartdata.classes.db';
+import { SmartdataDbCursor } from './smartdata.classes.cursor';
 import { IManager, SmartdataCollection } from './smartdata.classes.collection';
 
 export type TDocCreation = 'db' | 'new' | 'mixed';
@@ -41,6 +42,31 @@ export function unI() {
   };
 }
 
+export const convertFilterForMongoDb = (filterArg: { [key: string]: any }) => {
+  const convertedFilter: { [key: string]: any } = {};
+  const convertFilterArgument = (keyPathArg2: string, filterArg2: any) => {
+    if (typeof filterArg2 === 'object') {
+      for (const key of Object.keys(filterArg2)) {
+        if (key.startsWith('$')) {
+          convertedFilter[keyPathArg2] = filterArg2;
+          return;
+        } else if (key.includes('.')) {
+          throw new Error('keys cannot contain dots');
+        }
+      }
+      for (const key of Object.keys(filterArg2)) {
+        convertFilterArgument(`${keyPathArg2}.${key}`, filterArg2[key]);
+      }
+    } else {
+      convertedFilter[keyPathArg2] = filterArg2;
+    }
+  };
+  for (const key of Object.keys(filterArg)) {
+    convertFilterArgument(key, filterArg[key]);
+  }
+  return convertedFilter;
+};
+
 export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends IManager = any> {
   /**
    * the collection object an Doc belongs to
@@ -81,54 +107,81 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
    */
   constructor() {}
 
+  public static createInstanceFromMongoDbNativeDoc<T>(
+    this: plugins.tsclass.typeFest.Class<T>,
+    mongoDbNativeDocArg: any
+  ): T {
+    const newInstance = new this();
+    (newInstance as any).creationStatus = 'db';
+    for (const key of Object.keys(mongoDbNativeDocArg)) {
+      newInstance[key] = mongoDbNativeDocArg[key];
+    }
+    return newInstance;
+  }
+
+  /**
+   * gets all instances as array
+   * @param this
+   * @param filterArg
+   * @returns
+   */
   public static async getInstances<T>(
     this: plugins.tsclass.typeFest.Class<T>,
     filterArg: plugins.tsclass.typeFest.PartialDeep<T>
   ): Promise<T[]> {
-    const convertedFilter: any = {};
-    const convertFilterArgument = (keyPathArg: string, filterArg2: any) => {
-      if (typeof filterArg2 === 'object') {
-        for (const key of Object.keys(filterArg2)) {
-          if (key.startsWith('$')) {
-            convertedFilter[keyPathArg] = filterArg2;
-            return;
-          } else if (key.includes('.')) {
-            throw new Error('keys cannot contain dots');
-          }
-        }
-        for (const key of Object.keys(filterArg2)) {
-          convertFilterArgument(`${keyPathArg}.${key}`, filterArg2[key]);
-        } 
-      } else {
-        convertedFilter[keyPathArg] = filterArg2
-      }
-    }
-    for (const key of Object.keys(filterArg)) {
-      convertFilterArgument(key, filterArg[key]);
-    }
-    const foundDocs = await (this as any).collection.find(convertedFilter);
+    const foundDocs = await (this as any).collection.findAll(convertFilterForMongoDb(filterArg));
     const returnArray = [];
-    for (const item of foundDocs) {
-      const newInstance = new this();
-      (newInstance as any).creationStatus = 'db';
-      for (const key of Object.keys(item)) {
-        newInstance[key] = item[key];
-      }
+    for (const foundDoc of foundDocs) {
+      const newInstance: T = (this as any).createInstanceFromMongoDbNativeDoc(foundDoc);
       returnArray.push(newInstance);
     }
     return returnArray;
   }
 
+  /**
+   * gets the first matching instance
+   * @param this
+   * @param filterArg
+   * @returns
+   */
   public static async getInstance<T>(
     this: plugins.tsclass.typeFest.Class<T>,
     filterArg: plugins.tsclass.typeFest.PartialDeep<T>
   ): Promise<T> {
-    const result = await (this as any).getInstances(filterArg);
-    if (result && result.length > 0) {
-      return result[0];
+    const foundDoc = await (this as any).collection.findOne(convertFilterForMongoDb(filterArg));
+    if (foundDoc) {
+      const newInstance: T = (this as any).createInstanceFromMongoDbNativeDoc(foundDoc);
+      return newInstance;
+    } else {
+      return null;
     }
   }
 
+  /**
+   * get cursor
+   * @returns
+   */
+  public static async getCursor<T>(
+    this: plugins.tsclass.typeFest.Class<T>,
+    filterArg: plugins.tsclass.typeFest.PartialDeep<T>
+  ) {
+    const cursor: SmartdataDbCursor<T> = await (this as any).collection.getCursor(convertFilterForMongoDb(filterArg));
+    return cursor;
+  }
+
+  /**
+   * run a function for all instances
+   * @returns
+   */
+  public static async forEach<T>(
+    this: plugins.tsclass.typeFest.Class<T>,
+    filterArg: plugins.tsclass.typeFest.PartialDeep<T>,
+    forEachFunction: (itemArg: T) => Promise<any>
+  ) {
+    const cursor: SmartdataDbCursor<T> = await (this as any).getCursor(filterArg);
+    await cursor.forEach(forEachFunction)
+  }
+
   /**
    * saves this instance but not any connected items
    * may lead to data inconsistencies, but is faster

ts/smartdata.classes.easystore.ts

@@ -0,0 +1,93 @@
+import * as plugins from './smartdata.plugins';
+import { Collection } from './smartdata.classes.collection';
+import { SmartdataDb } from './smartdata.classes.db';
+import { SmartDataDbDoc, svDb, unI } from './smartdata.classes.doc';
+
+/**
+ * EasyStore allows the storage of easy objects. It also allows easy sharing of the object between different instances
+ */
+export class EasyStore<T> {
+  // instance
+  public smartdataDbRef: SmartdataDb;
+  public nameId: string;
+
+  private easyStoreClass = (() => {
+    @Collection(() => this.smartdataDbRef)
+    class SmartdataEasyStore extends SmartDataDbDoc<SmartdataEasyStore, SmartdataEasyStore> {
+      @unI()
+      public nameId: string;
+
+      @svDb()
+      public data: Partial<T>;
+    }
+    return SmartdataEasyStore;
+  })();
+
+  constructor(nameIdArg: string, smnartdataDbRefArg: SmartdataDb) {
+    this.smartdataDbRef = smnartdataDbRefArg;
+    this.nameId = nameIdArg;
+  }
+
+  private async getEasyStore() {
+    let easyStore = await this.easyStoreClass.getInstance({
+      nameId: this.nameId,
+    });
+
+    if (!easyStore) {
+      easyStore = new this.easyStoreClass();
+      easyStore.nameId = this.nameId;
+      easyStore.data = {};
+      await easyStore.save();
+    }
+    return easyStore;
+  }
+
+  /**
+   * reads all keyValue pairs at once and returns them
+   */
+  public async readAll() {
+    const easyStore = await this.getEasyStore();
+    return easyStore.data;
+  }
+
+  /**
+   * reads a keyValueFile from disk
+   */
+  public async readKey(keyArg: keyof T) {
+    const easyStore = await this.getEasyStore();
+    return easyStore.data[keyArg];
+  }
+
+  /**
+   * writes a specific key to the keyValueStore
+   */
+  public async writeKey(keyArg: keyof T, valueArg: any) {
+    const easyStore = await this.getEasyStore();
+    easyStore.data[keyArg] = valueArg;
+    await easyStore.save();
+  }
+
+  public async deleteKey(keyArg: keyof T) {
+    const easyStore = await this.getEasyStore();
+    delete easyStore.data[keyArg];
+    await easyStore.save();
+  }
+
+  /**
+   * writes all keyValue pairs in the object argument
+   */
+  public async writeAll(keyValueObject: Partial<T>) {
+    const easyStore = await this.getEasyStore();
+    easyStore.data = { ...easyStore.data, ...keyValueObject };
+    await easyStore.save();
+  }
+
+  /**
+   * wipes a key value store from disk
+   */
+  public async wipe() {
+    const easyStore = await this.getEasyStore();
+    easyStore.data = {};
+    await easyStore.save();
+  }
+}