3.1.29

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
+dist_*/
-dist_serve/
-dist_ts_web/
 
 # custom

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,21 +18,24 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - 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
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # test stage
@@ -41,37 +44,40 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci command npm run build
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -81,33 +87,35 @@ codequality:
   allow_failure: true
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:stable-dind
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -115,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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -10,6 +10,7 @@
     "npmRegistryUrl": "registry.npmjs.org"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,14 +1,14 @@
 {
   "name": "@pushrocks/smartdata",
-  "version": "3.1.25",
+  "version": "3.1.29",
   "private": false,
   "description": "do more with data",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
     "testLocal": "(npmdocker)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -21,36 +21,37 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartdata#README",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.17",
+    "@pushrocks/lik": "^4.0.13",
-    "@pushrocks/smartlog": "^2.0.21",
+    "@pushrocks/smartlog": "^2.0.35",
     "@pushrocks/smartpromise": "^3.0.6",
     "@pushrocks/smartstring": "^3.0.18",
-    "@pushrocks/smartunique": "^3.0.1",
+    "@pushrocks/smartunique": "^3.0.3",
-    "@types/lodash": "^4.14.149",
+    "@types/lodash": "^4.14.155",
-    "@types/mongodb": "^3.3.15",
+    "@types/mongodb": "^3.5.20",
     "lodash": "^4.17.15",
-    "mongodb": "^3.5.2",
+    "mongodb": "^3.5.8",
     "runtime-type-checks": "0.0.4"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.24",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tstest": "^1.0.33",
-    "@pushrocks/qenv": "^4.0.6",
+    "@pushrocks/qenv": "^4.0.10",
-    "@pushrocks/tapbundle": "^3.2.0",
+    "@pushrocks/tapbundle": "^3.2.1",
     "@types/mongodb-memory-server": "^2.3.0",
-    "@types/node": "^13.7.0",
+    "@types/node": "^14.0.13",
     "@types/shortid": "0.0.29",
-    "mongodb-memory-server": "^6.2.4",
+    "mongodb-memory-server": "^6.6.1",
-    "tslint": "^6.0.0",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
-    "ts/*",
+    "ts/**/*",
-    "ts_web/*",
+    "ts_web/**/*",
-    "dist/*",
+    "dist/**/*",
-    "dist_web/*",
+    "dist_*/**/*",
-    "dist_ts_web/*",
+    "dist_ts/**/*",
-    "assets/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -8,13 +8,20 @@ do more with data
 * [docs (typedoc)](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)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartdata.svg)](https://www.npmjs.com/package/@pushrocks/smartdata)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartdata/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartdata)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartdata/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartdata/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartdata)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+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
 
@@ -68,9 +75,9 @@ 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.
   }
@@ -97,7 +104,8 @@ 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 
+
+smartdata supports full CRUD operations
 
 **Store** or **Update** instances of classes to MongoDB:
 DbDoc extends your class with the following methods:
@@ -111,16 +119,13 @@ DbDoc extends your class with the following methods:
 **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 `.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).
+- 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. 
+- async `.delete()`will delete the document from DB.
-
-
-
 
 ## TypeScript
 
@@ -129,6 +134,11 @@ Since you define your classes in TypeScript and types flow through smartdata in
 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)

test/test.ts

@@ -44,7 +44,7 @@ tap.test('should establish a connection to the rethink Db cluster', async () =>
 @smartdata.Collection(() => {
   return testDb;
 })
-class Car extends smartdata.SmartDataDbDoc<Car> {
+class Car extends smartdata.SmartDataDbDoc<Car, Car> {
   @smartdata.unI()
   public index: string = smartunique.shortId();
 
@@ -101,13 +101,11 @@ tap.test('should be able to delete an instance of car', async () => {
   expect(myCar2.color).to.equal('red');
 });
 
-
-
 // tslint:disable-next-line: max-classes-per-file
 @smartdata.Collection(() => {
   return testDb;
 })
-class Truck extends smartdata.SmartDataDbDoc<Car> {
+class Truck extends smartdata.SmartDataDbDoc<Car, Car> {
   @smartdata.unI()
   public id: string = smartunique.shortId();
 
@@ -127,15 +125,13 @@ class Truck extends smartdata.SmartDataDbDoc<Car> {
 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'});
+  const myTruck = await Truck.getInstance<Truck>({ color: 'blue' });
   myTruck.id = 'foo';
   await myTruck.save();
-  const myTruck2 = await Truck.getInstance<Truck>({color: 'blue'});
+  const myTruck2 = await Truck.getInstance<Truck>({ color: 'blue' });
   console.log(myTruck2);
-
 });
 
-
 // =======================================
 // close the database connection
 // =======================================

ts/smartdata.classes.collection.ts

@@ -42,7 +42,7 @@ export class SmartdataCollection<T> {
   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;
@@ -103,7 +103,7 @@ export class SmartdataCollection<T> {
   /**
    * create an object in the database
    */
-  public 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);
@@ -115,7 +115,7 @@ 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();
@@ -134,7 +134,7 @@ export class SmartdataCollection<T> {
     );
   }
 
-  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();

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;
@@ -68,10 +69,7 @@ export class SmartdataDb {
   public async close(): Promise<any> {
     await this.mongoDbClient.close();
     this.status = 'disconnected';
-    plugins.smartlog.defaultLogger.log(
+    logger.log('info', `disconnected from database ${this.smartdataOptions.mongoDbName}`);
-      'info',
-      `disconnected from database ${this.smartdataOptions.mongoDbName}`
-    );
   }
 
   // handle table to class distribution

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,7 +41,7 @@ export function unI() {
   };
 }
 
-export class SmartDataDbDoc<T> {
+export class SmartDataDbDoc<T, TImplements> {
   /**
    * the collection object an Doc belongs to
    */
@@ -150,9 +150,9 @@ export class SmartDataDbDoc<T> {
    * also store any referenced objects to DB
    * better for data consistency
    */
-  public 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();
@@ -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() {
+  public async createSavableObject(): Promise<TImplements> {
-    const saveableObject: any = {}; // is not exposed to outside, so any is ok here
+    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);
 };