3.1.29

.gitignore

@@ -1,4 +1,20 @@
-node_modules/
-public/
-coverage/
 .nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,127 +18,104 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
   tags:
-  - docker
-  - notpriv
-
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
-  tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -146,5 +123,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,129 +0,0 @@
-# @pushrocks/smartdata
-
-do more with data and RethinkDB
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartdata)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartdata)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartdata)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartdata/)
-
-## Status for master
-
-[![build status](https://GitLab.com/pushrocks/smartdata/badges/master/build.svg)](https://GitLab.com/pushrocks/smartdata/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartdata/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartdata/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartdata.svg)](https://www.npmjs.com/package/smartdata)
-[![Dependency Status](https://david-dm.org/pushrocks/smartdata.svg)](https://david-dm.org/pushrocks/smartdata)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartdata/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartdata/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartdata/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartdata)
-[![Known Vulnerabilities](https://snyk.io/test/npm/smartdata/badge.svg)](https://snyk.io/test/npm/smartdata)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-## Usage
-
-Use TypeScript for best in class instellisense.
-
-smartdata is an ODM that adheres to TypeScript practices and uses classes to organize data.
-It uses RethinkDB as persistent storage.
-
-## Intention
-
-There are many ODMs out there, however when we searched for an ODM that uses TypeScript,
-acts smart while still embracing the NoSQL idea we didn't find a matching solution.
-This is why we started smartdata.
-
-How RethinkDB's terms map to the ones of smartdata:
-
-| MongoDb term | smartdata class               |
-| ------------ | ----------------------------- |
-| Database     | smartdata.SmartdataDb         |
-| Collection   | smartdata.SmartdataCollection |
-| Document     | smartdata.SmartadataDoc       |
-
-### class Db
-
-represents a Database. Naturally it has .connect() etc. methods on it.
-
-```typescript
-import * as smartdata from 'smartdata';
-
-const smartdataDb = new smartdata.SmartdataDb({
-  mongoDbUrl: '//someurl',
-  mongoDbName: 'myDatabase',
-  mongoDbPass: 'mypassword'
-});
-
-smartdataDb.connect();
-```
-
-### class DbCollection
-
-represents a collection of objects.
-A collection is defined by the object class (that is extending smartdata.dbdoc) it respresents
-
-So to get to get access to a specific collection you document
-
-```typescript
-// continues from the block before...
-
-@smartdata.Collection(smartdataDb)
-class MyObject extends smartdata.DbDoc<MyObject> {
-  // read the next block about DbDoc
-  @smartdata.svDb() property1: string; // @smartdata.svDb() marks the property for db save
-  property2: number; // this one is not marked, so it won't be save upon calling this.save()
-  constructor(optionsArg: { property1: string; property2: number }) {
-    super();
-  }
-}
-
-// start to instantiate instances of classes from scratch or database
-
-let localObject = new MyObject({
-  property1: 'hi',
-  property2: 2
-});
-localObject.save(); // saves the object to the database
-
-// start retrieving instances
-
-MyObject.getInstance<MyObject>({
-  property: 'hi'
-}); // outputs a new instance of MyObject with the values from db assigned
-```
-
-### class DbDoc
-
-represents a individual document in a collection
-and thereby is ideally suited to extend the class you want to actually store.
-
-**sStore** instances of classes to Db:
-DbDoc extends your class with the following methods:
-
-- `.save()` will save (or update) the object you call it on only. Any referenced non-savable objects will not get stored.
-- `.saveDeep()` does the same like `.save()`.
-  In addition it will look for properties that reference an object
-  that extends DbDoc as well and call .saveDeep() on them as well.
-  Loops are prevented
-
-**Get** a new class instance from a Doc in the DB:
-DbDoc exposes a static method that allows you specify a filter to retrieve a cloned class of the one you used to that doc at some point later in time. Yes, let that sink in a minute :)
-
-So you can just call `.getInstance({ /* filter props here */ })`.
-
-## TypeScript
-
-How does TypeScript play into this?
-Since you define your classes in TypeScript and types flow through smartdata in a generic way
-you should get all the Intellisense and type checking you love when using smartdata.
-smartdata itself also bundles typings.
-So you don't need to install any additional types when importing smartdata.
-
-For further information read the linked docs at the top of this README.
-
-> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

npmextra.json

@@ -8,5 +8,16 @@
     "npmGlobalTools": [],
     "npmAccessLevel": "public",
     "npmRegistryUrl": "registry.npmjs.org"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartdata",
+      "shortDescription": "do more with data",
+      "npmPackagename": "@pushrocks/smartdata",
+      "license": "MIT"
+    }
   }
-}
+}

package.json

@@ -1,14 +1,14 @@
 {
   "name": "@pushrocks/smartdata",
-  "version": "3.1.13",
+  "version": "3.1.29",
   "private": false,
   "description": "do more with data",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
     "testLocal": "(npmdocker)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -21,26 +21,39 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartdata#README",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.4",
-    "@pushrocks/smartlog": "^2.0.9",
-    "@pushrocks/smartpromise": "^2.0.5",
-    "@pushrocks/smartstring": "^3.0.5",
-    "@types/lodash": "^4.14.119",
-    "@types/mongodb": "^3.1.18",
-    "lodash": "^4.17.11",
-    "mongodb": "^3.1.10",
+    "@pushrocks/lik": "^4.0.13",
+    "@pushrocks/smartlog": "^2.0.35",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartstring": "^3.0.18",
+    "@pushrocks/smartunique": "^3.0.3",
+    "@types/lodash": "^4.14.155",
+    "@types/mongodb": "^3.5.20",
+    "lodash": "^4.17.15",
+    "mongodb": "^3.5.8",
     "runtime-type-checks": "0.0.4"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.4",
-    "@gitzone/tstest": "^1.0.18",
-    "@pushrocks/qenv": "^3.0.2",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.12.18",
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tstest": "^1.0.33",
+    "@pushrocks/qenv": "^4.0.10",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/mongodb-memory-server": "^2.3.0",
+    "@types/node": "^14.0.13",
     "@types/shortid": "0.0.29",
-    "mongodb-memory-server": "^2.9.1",
-    "shortid": "^2.2.14",
-    "tslint": "^5.12.0",
-    "tslint-config-prettier": "^1.17.0"
-  }
+    "mongodb-memory-server": "^6.6.1",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,147 @@
+# @pushrocks/smartdata
+do more with data
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartdata)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartdata)
+* [github.com (source mirror)](https://github.com/pushrocks/smartdata)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartdata/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartdata/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartdata/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartdata)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartdata)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartdata)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartdata)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartdata)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+smartdata is an ODM that adheres to TypeScript practices and uses classes to organize data.
+It uses RethinkDB as persistent storage.
+
+## Intention
+
+There are many ODMs out there, however when we searched for an ODM that uses TypeScript,
+acts smart while still embracing the NoSQL idea we didn't find a matching solution.
+This is why we started smartdata.
+
+How RethinkDB's terms map to the ones of smartdata:
+
+| MongoDb term | smartdata class               |
+| ------------ | ----------------------------- |
+| Database     | smartdata.SmartdataDb         |
+| Collection   | smartdata.SmartdataCollection |
+| Document     | smartdata.SmartadataDoc       |
+
+### class Db
+
+represents a Database. Naturally it has .connect() etc. methods on it.
+
+```typescript
+import * as smartdata from 'smartdata';
+
+const smartdataDb = new smartdata.SmartdataDb({
+  mongoDbUrl: '//someurl',
+  mongoDbName: 'myDatabase',
+  mongoDbPass: 'mypassword'
+});
+
+smartdataDb.connect();
+```
+
+### class DbCollection
+
+represents a collection of objects.
+A collection is defined by the object class (that is extending smartdata.dbdoc) it respresents
+
+So to get to get access to a specific collection you document
+
+```typescript
+// continues from the block before...
+
+@smartdata.Collection(smartdataDb)
+class MyObject extends smartdata.DbDoc<MyObject> {
+  // read the next block about DbDoc
+  @smartdata.svDb()
+  property1: string; // @smartdata.svDb() marks the property for db save
+
+  property2: number; // this one is not marked, so it won't be save upon calling this.save()
+
+  constructor() {
+    super(); // the super call is important ;) But you probably know that.
+  }
+}
+
+// start to instantiate instances of classes from scratch or database
+
+const localObject = new MyObject({
+  property1: 'hi',
+  property2: 2
+});
+localObject.save(); // saves the object to the database
+
+// start retrieving instances
+
+MyObject.getInstance<MyObject>({
+  property: 'hi'
+}); // outputs a new instance of MyObject with the values from db assigned
+```
+
+### class DbDoc
+
+represents a individual document in a collection
+and thereby is ideally suited to extend the class you want to actually store.
+
+### CRUD operations
+
+smartdata supports full CRUD operations
+
+**Store** or **Update** instances of classes to MongoDB:
+DbDoc extends your class with the following methods:
+
+- async `.save()` will save (or update) the object you call it on only. Any referenced non-savable objects will not get stored.
+- async `.saveDeep()` does the same like `.save()`.
+  In addition it will look for properties that reference an object
+  that extends DbDoc as well and call .saveDeep() on them as well.
+  Loops are prevented
+
+**Get** a new class instance from MongoDB:
+DbDoc exposes a static method that allows you specify a filter to retrieve a cloned class of the one you used to that doc at some point later in time:
+
+- static async `.getInstance({ /* filter props here */ })` gets you an instance that has the data of the first matched document as properties.
+- static async `getInstances({ /* filter props here */ })` get you an array instances (one instance for every matched document).
+
+**Delete** instances from MongoDb:
+smartdata extends your class with a method to easily delete the doucment from DB:
+
+- async `.delete()`will delete the document from DB.
+
+## TypeScript
+
+How does TypeScript play into this?
+Since you define your classes in TypeScript and types flow through smartdata in a generic way
+you should get all the Intellisense and type checking you love when using smartdata.
+smartdata itself also bundles typings. You don't need to install any additional types for smartdata.
+
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,22 +1,32 @@
 import { tap, expect } from '@pushrocks/tapbundle';
-import * as smartpromise from '@pushrocks/smartpromise';
 import { Qenv } from '@pushrocks/qenv';
 
-let testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/');
+const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/');
 
 // the tested module
 import * as smartdata from '../ts/index';
 import { smartstring } from '../ts/smartdata.plugins';
-import * as shortid from 'shortid';
+import * as smartunique from '@pushrocks/smartunique';
+
+import * as mongoPlugin from 'mongodb-memory-server';
 
 // =======================================
 // Connecting to the database server
 // =======================================
 
-let testDb = new smartdata.SmartdataDb({
-  mongoDbName: process.env.MONGO_DBNAME,
-  mongoDbUrl: process.env.MONGO_URL,
-  mongoDbPass: process.env.MONGO_PASS
+let testDb: smartdata.SmartdataDb;
+let smartdataOptions: smartdata.ISmartdataOptions;
+let mongod: mongoPlugin.MongoMemoryServer;
+
+tap.test('should create a testinstance as database', async () => {
+  mongod = new mongoPlugin.MongoMemoryServer();
+  smartdataOptions = {
+    mongoDbName: await mongod.getDbName(),
+    mongoDbPass: '',
+    mongoDbUrl: await mongod.getConnectionString()
+  };
+  console.log(smartdataOptions);
+  testDb = new smartdata.SmartdataDb(smartdataOptions);
 });
 
 tap.test('should establish a connection to the rethink Db cluster', async () => {
@@ -31,11 +41,19 @@ tap.test('should establish a connection to the rethink Db cluster', async () =>
 // Collections
 // ------
 
-@smartdata.Collection(testDb)
-class Car extends smartdata.SmartDataDbDoc<Car> {
-  @smartdata.unI() index: string = shortid();
-  @smartdata.svDb() color: string;
-  @smartdata.svDb() brand: string;
+@smartdata.Collection(() => {
+  return testDb;
+})
+class Car extends smartdata.SmartDataDbDoc<Car, Car> {
+  @smartdata.unI()
+  public index: string = smartunique.shortId();
+
+  @smartdata.svDb()
+  public color: string;
+
+  @smartdata.svDb()
+  public brand: string;
+
   constructor(colorArg: string, brandArg: string) {
     super();
     this.color = colorArg;
@@ -46,20 +64,80 @@ class Car extends smartdata.SmartDataDbDoc<Car> {
 tap.test('should save the car to the db', async () => {
   const myCar = new Car('red', 'Volvo');
   await myCar.save();
+
+  const myCar2 = new Car('red', 'Volvo');
+  await myCar2.save();
+
+  const myCar3 = new Car('red', 'Renault');
+  await myCar3.save();
 });
 
 tap.test('expect to get instance of Car', async () => {
-  let myCars = await Car.getInstances<Car>({
+  const myCars = await Car.getInstances<Car>({
     brand: 'Volvo'
   });
   expect(myCars[0].color).to.equal('red');
 });
 
+tap.test('expect to get instance of Car and update it', async () => {
+  const myCar = await Car.getInstance<Car>({
+    brand: 'Volvo'
+  });
+  expect(myCar.color).to.equal('red');
+  myCar.color = 'blue';
+  await myCar.save();
+});
+
+tap.test('should be able to delete an instance of car', async () => {
+  const myCar = await Car.getInstance<Car>({
+    brand: 'Volvo'
+  });
+  expect(myCar.color).to.equal('blue');
+  await myCar.delete();
+
+  const myCar2 = await Car.getInstance<Car>({
+    brand: 'Volvo'
+  });
+  expect(myCar2.color).to.equal('red');
+});
+
+// tslint:disable-next-line: max-classes-per-file
+@smartdata.Collection(() => {
+  return testDb;
+})
+class Truck extends smartdata.SmartDataDbDoc<Car, Car> {
+  @smartdata.unI()
+  public id: string = smartunique.shortId();
+
+  @smartdata.svDb()
+  public color: string;
+
+  @smartdata.svDb()
+  public brand: string;
+
+  constructor(colorArg: string, brandArg: string) {
+    super();
+    this.color = colorArg;
+    this.brand = brandArg;
+  }
+}
+
+tap.test('should store a new Truck', async () => {
+  const truck = new Truck('blue', 'MAN');
+  await truck.save();
+  const myTruck = await Truck.getInstance<Truck>({ color: 'blue' });
+  myTruck.id = 'foo';
+  await myTruck.save();
+  const myTruck2 = await Truck.getInstance<Truck>({ color: 'blue' });
+  console.log(myTruck2);
+});
+
 // =======================================
 // close the database connection
 // =======================================
 tap.test('should close the database connection', async tools => {
   await testDb.close();
+  await mongod.stop();
 });
 
 tap.start({ throwOnError: true });

ts/index.ts

@@ -2,4 +2,4 @@ export * from './smartdata.classes.db';
 export * from './smartdata.classes.collection';
 export * from './smartdata.classes.doc';
 
-export { IMongoDescriptor } from './interfaces';
+export { IMongoDescriptor } from './interfaces';

ts/interfaces/index.ts

@@ -1 +1 @@
-export * from './mongodescriptor';
+export * from './mongodescriptor';

ts/smartdata.classes.collection.ts

@@ -26,10 +26,9 @@ export function Collection(dbArg: SmartdataDb | TDelayedDbCreation) {
       constructor['smartdataCollection'] = new SmartdataCollection(constructor, dbArg);
     } else {
       constructor['smartdataDelayedCollection'] = () => {
-        return new SmartdataCollection(constructor, dbArg()); 
+        return new SmartdataCollection(constructor, dbArg());
       };
     }
-    
   };
 }
 
@@ -37,13 +36,13 @@ export class SmartdataCollection<T> {
   /**
    * the collection that is used
    */
-  mongoDbCollection: plugins.mongodb.Collection;
-  objectValidation: IDocValidationFunc<T> = null;
-  collectionName: string;
-  smartdataDb: SmartdataDb;
-  uniqueIndexes: string[] = [];
+  public mongoDbCollection: plugins.mongodb.Collection;
+  public objectValidation: IDocValidationFunc<T> = null;
+  public collectionName: string;
+  public smartdataDb: SmartdataDb;
+  public uniqueIndexes: string[] = [];
 
-  constructor(collectedClassArg: T & SmartDataDbDoc<T>, smartDataDbArg: SmartdataDb) {
+  constructor(collectedClassArg: T & SmartDataDbDoc<T, unknown>, smartDataDbArg: SmartdataDb) {
     // tell the collection where it belongs
     this.collectionName = collectedClassArg.name;
     this.smartdataDb = smartDataDbArg;
@@ -55,7 +54,7 @@ export class SmartdataCollection<T> {
   /**
    * makes sure a collection exists within MongoDb that maps to the SmartdataCollection
    */
-  async init() {
+  public async init() {
     if (!this.mongoDbCollection) {
       // connect this instance to a MongoDB collection
       const availableMongoDbCollections = await this.smartdataDb.mongoDb.collections();
@@ -66,15 +65,15 @@ export class SmartdataCollection<T> {
         await this.smartdataDb.mongoDb.createCollection(this.collectionName);
       }
       this.mongoDbCollection = await this.smartdataDb.mongoDb.collection(this.collectionName);
-      console.log(`Successfully initiated Collection ${this.collectionName}`);
+      // console.log(`Successfully initiated Collection ${this.collectionName}`);
     }
   }
 
   /**
    * mark unique index
    */
-  markUniqueIndexes(keyArrayArg: string[] = []) {
-    for (let key of keyArrayArg) {
+  public markUniqueIndexes(keyArrayArg: string[] = []) {
+    for (const key of keyArrayArg) {
       if (!this.uniqueIndexes.includes(key)) {
         this.mongoDbCollection.createIndex(key, {
           unique: true
@@ -88,14 +87,14 @@ export class SmartdataCollection<T> {
   /**
    * adds a validation function that all newly inserted and updated objects have to pass
    */
-  addDocValidation(funcArg: IDocValidationFunc<T>) {
+  public addDocValidation(funcArg: IDocValidationFunc<T>) {
     this.objectValidation = funcArg;
   }
 
   /**
    * finds an object in the DbCollection
    */
-  async find(filterObject: any): Promise<any> {
+  public async find(filterObject: any): Promise<any> {
     await this.init();
     const result = await this.mongoDbCollection.find(filterObject).toArray();
     return result;
@@ -104,7 +103,7 @@ export class SmartdataCollection<T> {
   /**
    * create an object in the database
    */
-  async insert(dbDocArg: T & SmartDataDbDoc<T>): Promise<any> {
+  public async insert(dbDocArg: T & SmartDataDbDoc<T, unknown>): Promise<any> {
     await this.init();
     await this.checkDoc(dbDocArg);
     this.markUniqueIndexes(dbDocArg.uniqueIndexes);
@@ -116,19 +115,32 @@ export class SmartdataCollection<T> {
   /**
    * inserts object into the DbCollection
    */
-  public async update(dbDocArg: T & SmartDataDbDoc<T>): Promise<any> {
+  public async update(dbDocArg: T & SmartDataDbDoc<T, unknown>): Promise<any> {
     await this.init();
     await this.checkDoc(dbDocArg);
     const identifiableObject = await dbDocArg.createIdentifiableObject();
     const saveableObject = await dbDocArg.createSavableObject();
-    this.mongoDbCollection.updateOne(identifiableObject, saveableObject);
+    const updateableObject: any = {};
+    for (const key of Object.keys(saveableObject)) {
+      if (identifiableObject[key]) {
+        continue;
+      }
+      updateableObject[key] = saveableObject[key];
+    }
+    this.mongoDbCollection.updateOne(
+      identifiableObject,
+      { $set: updateableObject },
+      { upsert: true }
+    );
   }
 
-  public async delete (dbDocArg: T & SmartDataDbDoc<T>): Promise<any> {
+  public async delete(dbDocArg: T & SmartDataDbDoc<T, unknown>): Promise<any> {
     await this.init();
     await this.checkDoc(dbDocArg);
     const identifiableObject = await dbDocArg.createIdentifiableObject();
-    this.mongoDbCollection.deleteOne(identifiableObject);
+    await this.mongoDbCollection.deleteOne(identifiableObject, {
+      w: 1
+    });
   }
 
   /**

ts/smartdata.classes.db.ts

@@ -1,9 +1,10 @@
 import * as plugins from './smartdata.plugins';
-import { Objectmap } from '@pushrocks/lik';
+import { ObjectMap } from '@pushrocks/lik';
 
 import { SmartdataCollection } from './smartdata.classes.collection';
 
 import * as mongoHelpers from './smartdata.mongohelpers';
+import { logger } from './smartdata.logging';
 
 /**
  * interface - indicates the connection status of the db
@@ -32,7 +33,7 @@ export class SmartdataDb {
   mongoDbClient: plugins.mongodb.MongoClient;
   mongoDb: plugins.mongodb.Db;
   status: TConnectionStatus;
-  smartdataCollectionMap = new Objectmap<SmartdataCollection<any>>();
+  smartdataCollectionMap = new ObjectMap<SmartdataCollection<any>>();
 
   constructor(smartdataOptions: ISmartdataOptions) {
     this.smartdataOptions = smartdataOptions;
@@ -44,7 +45,7 @@ export class SmartdataDb {
   /**
    * connects to the database that was specified during instance creation
    */
-  async init(): Promise<any> {
+  public async init(): Promise<any> {
     let finalConnectionUrl = this.smartdataOptions.mongoDbUrl;
     if (this.smartdataOptions.mongoDbPass) {
       finalConnectionUrl = mongoHelpers.addPassword(
@@ -52,13 +53,11 @@ export class SmartdataDb {
         this.smartdataOptions.mongoDbPass
       );
     }
-    console.log(finalConnectionUrl);
-    this.mongoDbClient = await plugins.mongodb.MongoClient.connect(
-      finalConnectionUrl,
-      {
-        useNewUrlParser: true
-      }
-    );
+    console.log(`connection Url: ${finalConnectionUrl}`);
+    this.mongoDbClient = await plugins.mongodb.MongoClient.connect(finalConnectionUrl, {
+      useNewUrlParser: true,
+      useUnifiedTopology: true
+    });
     this.mongoDb = this.mongoDbClient.db(this.smartdataOptions.mongoDbName);
     this.status = 'connected';
     console.log(`Connected to database ${this.smartdataOptions.mongoDbName}`);
@@ -67,18 +66,15 @@ export class SmartdataDb {
   /**
    * closes the connection to the databse
    */
-  async close(): Promise<any> {
+  public async close(): Promise<any> {
     await this.mongoDbClient.close();
     this.status = 'disconnected';
-    plugins.smartlog.defaultLogger.log(
-      'info',
-      `disconnected from database ${this.smartdataOptions.mongoDbName}`
-    );
+    logger.log('info', `disconnected from database ${this.smartdataOptions.mongoDbName}`);
   }
 
   // handle table to class distribution
 
-  addTable(SmartdataCollectionArg: SmartdataCollection<any>) {
+  public addTable(SmartdataCollectionArg: SmartdataCollection<any>) {
     this.smartdataCollectionMap.add(SmartdataCollectionArg);
   }
 
@@ -87,8 +83,8 @@ export class SmartdataDb {
    * @param nameArg
    * @returns DbTable
    */
-  async getSmartdataCollectionByName<T>(nameArg: string): Promise<SmartdataCollection<T>> {
-    let resultCollection = this.smartdataCollectionMap.find(dbTableArg => {
+  public async getSmartdataCollectionByName<T>(nameArg: string): Promise<SmartdataCollection<T>> {
+    const resultCollection = this.smartdataCollectionMap.find(dbTableArg => {
       return dbTableArg.collectionName === nameArg;
     });
     return resultCollection;

ts/smartdata.classes.doc.ts

@@ -1,6 +1,6 @@
 import * as plugins from './smartdata.plugins';
 
-import { Objectmap } from '@pushrocks/lik';
+import { ObjectMap } from '@pushrocks/lik';
 
 import { SmartdataDb } from './smartdata.classes.db';
 import { SmartdataCollection } from './smartdata.classes.collection';
@@ -11,7 +11,7 @@ export type TDocCreation = 'db' | 'new' | 'mixed';
  * saveable - saveable decorator to be used on class properties
  */
 export function svDb() {
-  return (target: SmartDataDbDoc<any>, key: string) => {
+  return (target: SmartDataDbDoc<unknown, unknown>, key: string) => {
     console.log(`called svDb() on ${key}`);
     if (!target.saveableProperties) {
       target.saveableProperties = [];
@@ -24,7 +24,7 @@ export function svDb() {
  * unique index - decorator to mark a unique index
  */
 export function unI() {
-  return (target: SmartDataDbDoc<any>, key: string) => {
+  return (target: SmartDataDbDoc<unknown, unknown>, key: string) => {
     console.log('called unI');
 
     // mark the index as unique
@@ -41,43 +41,43 @@ export function unI() {
   };
 }
 
-export class SmartDataDbDoc<T> {
+export class SmartDataDbDoc<T, TImplements> {
   /**
    * the collection object an Doc belongs to
    */
-  collection: SmartdataCollection<T>;
+  public collection: SmartdataCollection<T>;
 
   /**
    * how the Doc in memory was created, may prove useful later.
    */
-  creationStatus: TDocCreation = 'new';
+  public creationStatus: TDocCreation = 'new';
 
   /**
    * unique indexes
    */
-  uniqueIndexes: string[];
+  public uniqueIndexes: string[];
 
   /**
    * an array of saveable properties of a doc
    */
-  saveableProperties: string[];
+  public saveableProperties: string[];
 
   /**
    * name
    */
-  name: string;
+  public name: string;
 
   /**
    * primary id in the database
    */
-  dbDocUniqueId: string;
+  public dbDocUniqueId: string;
 
   /**
    * class constructor
    */
   constructor() {
     this.name = this.constructor['name'];
-    if(this.constructor['smartdataCollection']) {
+    if (this.constructor['smartdataCollection']) {
       // tslint:disable-next-line: no-string-literal
       this.collection = this.constructor['smartdataCollection'];
       // tslint:disable-next-line: no-string-literal
@@ -89,31 +89,30 @@ export class SmartDataDbDoc<T> {
     }
   }
 
-  static async getInstances<T>(filterArg): Promise<T[]> {
-    let self: any = this; // fool typesystem
+  public static async getInstances<T>(filterArg): Promise<T[]> {
+    const self: any = this; // fool typesystem
     let referenceMongoDBCollection: SmartdataCollection<T>;
-    
+
     if (self.smartdataCollection) {
       referenceMongoDBCollection = self.smartdataCollection;
     } else if (self.smartdataDelayedCollection) {
       referenceMongoDBCollection = self.smartdataDelayedCollection();
-    };
+    }
     const foundDocs = await referenceMongoDBCollection.find(filterArg);
     const returnArray = [];
-    for (let item of foundDocs) {
-      let newInstance = new this();
-      for (let key in item) {
-        if (key !== 'id') {
-          newInstance[key] = item[key];
-        }
+    for (const item of foundDocs) {
+      const newInstance = new this();
+      newInstance.creationStatus = 'db';
+      for (const key of Object.keys(item)) {
+        newInstance[key] = item[key];
       }
       returnArray.push(newInstance);
     }
     return returnArray;
   }
 
-  static async getInstance<T>(filterArg): Promise<T> {
-    let result = await this.getInstances<T>(filterArg);
+  public static async getInstance<T>(filterArg): Promise<T> {
+    const result = await this.getInstances<T>(filterArg);
     if (result && result.length > 0) {
       return result[0];
     }
@@ -123,15 +122,15 @@ export class SmartDataDbDoc<T> {
    * saves this instance but not any connected items
    * may lead to data inconsistencies, but is faster
    */
-  async save() {
+  public async save() {
     // tslint:disable-next-line: no-this-assignment
-    let self: any = this;
+    const self: any = this;
     switch (this.creationStatus) {
       case 'db':
         await this.collection.update(self);
         break;
       case 'new':
-        let writeResult = await this.collection.insert(self);
+        const writeResult = await this.collection.insert(self);
         this.creationStatus = 'db';
         break;
       default:
@@ -142,22 +141,23 @@ export class SmartDataDbDoc<T> {
   /**
    * deletes a document from the database
    */
-  async delete() {
-
+  public async delete() {
+    const self: any = this;
+    await this.collection.delete(self);
   }
 
   /**
    * also store any referenced objects to DB
    * better for data consistency
    */
-  saveDeep(savedMapArg: Objectmap<SmartDataDbDoc<any>> = null) {
+  public saveDeep(savedMapArg: ObjectMap<SmartDataDbDoc<any, any>> = null) {
     if (!savedMapArg) {
-      savedMapArg = new Objectmap<SmartDataDbDoc<any>>();
+      savedMapArg = new ObjectMap<SmartDataDbDoc<any, any>>();
     }
     savedMapArg.add(this);
     this.save();
-    for (let propertyKey in this) {
-      let property: any = this[propertyKey];
+    for (const propertyKey of Object.keys(this)) {
+      const property: any = this[propertyKey];
       if (property instanceof SmartDataDbDoc && !savedMapArg.checkForObject(property)) {
         property.saveDeep(savedMapArg);
       }
@@ -167,12 +167,12 @@ export class SmartDataDbDoc<T> {
   /**
    * creates a saveable object so the instance can be persisted as json in the database
    */
-  public async createSavableObject() {
-    const saveableObject: any = {}; // is not exposed to outside, so any is ok here
+  public async createSavableObject(): Promise<TImplements> {
+    const saveableObject: unknown = {}; // is not exposed to outside, so any is ok here
     for (const propertyNameString of this.saveableProperties) {
       saveableObject[propertyNameString] = this[propertyNameString];
     }
-    return saveableObject;
+    return saveableObject as TImplements;
   }
 
   /**

ts/smartdata.logging.ts

@@ -0,0 +1,3 @@
+import * as plugins from './smartdata.plugins';
+
+export const logger = new plugins.smartlog.ConsoleLog();

ts/smartdata.mongohelpers.ts

@@ -1,3 +1,7 @@
+export const addUsername = (mongoUrlArg: string, usernameArg: string): string => {
+  return mongoUrlArg.replace('<USERNAME>', usernameArg);
+};
+
 export const addPassword = (mongoUrlArg: string, passwordArg: string): string => {
   return mongoUrlArg.replace('<PASSWORD>', passwordArg);
 };

ts/smartdata.plugins.ts

@@ -4,5 +4,6 @@ import * as lodash from 'lodash';
 import * as mongodb from 'mongodb';
 import * as smartq from '@pushrocks/smartpromise';
 import * as smartstring from '@pushrocks/smartstring';
+import * as smartunique from '@pushrocks/smartunique';
 
-export { assert, smartlog, lodash, smartq, mongodb, smartstring };
+export { assert, smartlog, lodash, smartq, mongodb, smartstring, smartunique };