3.1.40

.gitlab-ci.yml

@@ -19,23 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+
+auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartdata",
-  "version": "3.1.28",
+  "version": "3.1.40",
   "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.13",
+    "@pushrocks/lik": "^4.0.17",
-    "@pushrocks/smartlog": "^2.0.35",
+    "@pushrocks/smartlog": "^2.0.36",
     "@pushrocks/smartpromise": "^3.0.6",
     "@pushrocks/smartstring": "^3.0.18",
-    "@pushrocks/smartunique": "^3.0.3",
+    "@types/lodash": "^4.14.159",
-    "@types/lodash": "^4.14.155",
+    "@types/mongodb": "^3.5.26",
-    "@types/mongodb": "^3.5.20",
+    "lodash": "^4.17.20",
-    "lodash": "^4.17.15",
+    "mongodb": "^3.6.0",
-    "mongodb": "^3.5.8",
     "runtime-type-checks": "0.0.4"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.33",
+    "@gitzone/tstest": "^1.0.44",
     "@pushrocks/qenv": "^4.0.10",
-    "@pushrocks/tapbundle": "^3.2.1",
+    "@pushrocks/smartunique": "^3.0.3",
+    "@pushrocks/tapbundle": "^3.2.9",
     "@types/mongodb-memory-server": "^2.3.0",
-    "@types/node": "^14.0.13",
+    "@types/node": "^14.6.0",
     "@types/shortid": "0.0.29",
-    "mongodb-memory-server": "^6.6.1",
+    "mongodb-memory-server": "6.6.3",
-    "tslint": "^6.1.2",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
@@ -55,5 +55,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

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
 
@@ -47,7 +54,7 @@ import * as smartdata from 'smartdata';
 const smartdataDb = new smartdata.SmartdataDb({
   mongoDbUrl: '//someurl',
   mongoDbName: 'myDatabase',
-  mongoDbPass: 'mypassword'
+  mongoDbPass: 'mypassword',
 });
 
 smartdataDb.connect();
@@ -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.
   }
@@ -80,14 +87,14 @@ class MyObject extends smartdata.DbDoc<MyObject> {
 
 const localObject = new MyObject({
   property1: 'hi',
-  property2: 2
+  property2: 2,
 });
 localObject.save(); // saves the object to the database
 
 // start retrieving instances
 
 MyObject.getInstance<MyObject>({
-  property: 'hi'
+  property: 'hi',
 }); // outputs a new instance of MyObject with the values from db assigned
 ```
 
@@ -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,10 @@ 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

@@ -5,31 +5,44 @@ 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 smartunique from '@pushrocks/smartunique';
 
 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.ISmartdataOptions;
+let smartdataOptions: smartdata.IMongoDescriptor;
 let mongod: mongoPlugin.MongoMemoryServer;
 
-tap.test('should create a testinstance as database', async () => {
+tap.skip.test('should create a testinstance as database', async () => {
-  mongod = new mongoPlugin.MongoMemoryServer();
+  mongod = new mongoPlugin.MongoMemoryServer({
+  });
+  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.getConnectionString()
+    mongoDbUrl: await mongod.getConnectionString(),
   };
   console.log(smartdataOptions);
   testDb = new smartdata.SmartdataDb(smartdataOptions);
 });
 
-tap.test('should establish a connection to the rethink Db cluster', async () => {
+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
+  });
+});
+
+tap.test('should establish a connection to mongod', async () => {
   await testDb.init();
 });
 
@@ -74,14 +87,14 @@ tap.test('should save the car to the db', async () => {
 
 tap.test('expect to get instance of Car', async () => {
   const myCars = await Car.getInstances<Car>({
-    brand: 'Volvo'
+    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'
+    brand: 'Volvo',
   });
   expect(myCar.color).to.equal('red');
   myCar.color = 'blue';
@@ -90,13 +103,13 @@ tap.test('expect to get instance of Car and update it', async () => {
 
 tap.test('should be able to delete an instance of car', async () => {
   const myCar = await Car.getInstance<Car>({
-    brand: 'Volvo'
+    brand: 'Volvo',
   });
   expect(myCar.color).to.equal('blue');
   await myCar.delete();
 
   const myCar2 = await Car.getInstance<Car>({
-    brand: 'Volvo'
+    brand: 'Volvo',
   });
   expect(myCar2.color).to.equal('red');
 });
@@ -135,9 +148,12 @@ tap.test('should store a new Truck', async () => {
 // =======================================
 // close the database connection
 // =======================================
-tap.test('should close the database connection', async tools => {
+tap.test('should close the database connection', async (tools) => {
   await testDb.close();
-  await mongod.stop();
+  try {
+    
+    await mongod.stop();
+  } catch (e) {}
 });
 
 tap.start({ throwOnError: true });

ts/interfaces/mongodescriptor.ts

@@ -1,5 +1,22 @@
 export interface IMongoDescriptor {
-  mongoDbName: string;
+  /**
+   * the URL to connect to
+   */
   mongoDbUrl: string;
-  mongoDbPass: string;
+
+  /**
+   * the db to use for the project
+   */
+  mongoDbName?: string;
+
+  /**
+   * a username to use to connect to the database
+   */
+
+  mongoDbUser?: string;
+
+  /**
+   * an optional password that will be replace <PASSWORD> in the connection string
+   */
+  mongoDbPass?: string;
 }

ts/smartdata.classes.collection.ts

@@ -20,7 +20,7 @@ export type TDelayedDbCreation = () => SmartdataDb;
  * @param dbArg
  */
 export function Collection(dbArg: SmartdataDb | TDelayedDbCreation) {
-  return function(constructor) {
+  return function (constructor) {
     if (dbArg instanceof SmartdataDb) {
       // tslint:disable-next-line: no-string-literal
       constructor['smartdataCollection'] = new SmartdataCollection(constructor, dbArg);
@@ -58,7 +58,7 @@ export class SmartdataCollection<T> {
     if (!this.mongoDbCollection) {
       // connect this instance to a MongoDB collection
       const availableMongoDbCollections = await this.smartdataDb.mongoDb.collections();
-      const wantedCollection = availableMongoDbCollections.find(collection => {
+      const wantedCollection = availableMongoDbCollections.find((collection) => {
         return collection.collectionName === this.collectionName;
       });
       if (!wantedCollection) {
@@ -76,7 +76,7 @@ export class SmartdataCollection<T> {
     for (const key of keyArrayArg) {
       if (!this.uniqueIndexes.includes(key)) {
         this.mongoDbCollection.createIndex(key, {
-          unique: true
+          unique: true,
         });
         // make sure we only call this once and not for every doc we create
         this.uniqueIndexes.push(key);
@@ -139,7 +139,7 @@ export class SmartdataCollection<T> {
     await this.checkDoc(dbDocArg);
     const identifiableObject = await dbDocArg.createIdentifiableObject();
     await this.mongoDbCollection.deleteOne(identifiableObject, {
-      w: 1
+      w: 1,
     });
   }
 

ts/smartdata.classes.db.ts

@@ -3,39 +3,22 @@ import { ObjectMap } from '@pushrocks/lik';
 
 import { SmartdataCollection } from './smartdata.classes.collection';
 
-import * as mongoHelpers from './smartdata.mongohelpers';
 import { logger } from './smartdata.logging';
+import { IMongoDescriptor } from './interfaces';
 
 /**
  * interface - indicates the connection status of the db
  */
 export type TConnectionStatus = 'initial' | 'disconnected' | 'connected' | 'failed';
 
-export interface ISmartdataOptions {
-  /**
-   * the URL to connect to
-   */
-  mongoDbUrl: string;
-
-  /**
-   * the db to use for the project
-   */
-  mongoDbName: string;
-
-  /**
-   * an optional password that will be replace <PASSWORD> in the connection string
-   */
-  mongoDbPass?: string;
-}
-
 export class SmartdataDb {
-  smartdataOptions: ISmartdataOptions;
+  smartdataOptions: IMongoDescriptor;
   mongoDbClient: plugins.mongodb.MongoClient;
   mongoDb: plugins.mongodb.Db;
   status: TConnectionStatus;
   smartdataCollectionMap = new ObjectMap<SmartdataCollection<any>>();
 
-  constructor(smartdataOptions: ISmartdataOptions) {
+  constructor(smartdataOptions: IMongoDescriptor) {
     this.smartdataOptions = smartdataOptions;
     this.status = 'initial';
   }
@@ -46,17 +29,17 @@ export class SmartdataDb {
    * connects to the database that was specified during instance creation
    */
   public async init(): Promise<any> {
-    let finalConnectionUrl = this.smartdataOptions.mongoDbUrl;
+    const finalConnectionUrl = this.smartdataOptions.mongoDbUrl
-    if (this.smartdataOptions.mongoDbPass) {
+      .replace('<USERNAME>', this.smartdataOptions.mongoDbUser)
-      finalConnectionUrl = mongoHelpers.addPassword(
+      .replace('<username>', this.smartdataOptions.mongoDbUser)
-        this.smartdataOptions.mongoDbUrl,
+      .replace('<PASSWORD>', this.smartdataOptions.mongoDbPass)
-        this.smartdataOptions.mongoDbPass
+      .replace('<password>', this.smartdataOptions.mongoDbPass)
-      );
+      .replace('<DBNAME>', this.smartdataOptions.mongoDbName)
-    }
+      .replace('<dbname>', this.smartdataOptions.mongoDbName);
-    console.log(`connection Url: ${finalConnectionUrl}`);
+
     this.mongoDbClient = await plugins.mongodb.MongoClient.connect(finalConnectionUrl, {
       useNewUrlParser: true,
-      useUnifiedTopology: true
+      useUnifiedTopology: true,
     });
     this.mongoDb = this.mongoDbClient.db(this.smartdataOptions.mongoDbName);
     this.status = 'connected';
@@ -84,7 +67,7 @@ export class SmartdataDb {
    * @returns DbTable
    */
   public async getSmartdataCollectionByName<T>(nameArg: string): Promise<SmartdataCollection<T>> {
-    const resultCollection = this.smartdataCollectionMap.find(dbTableArg => {
+    const resultCollection = this.smartdataCollectionMap.find((dbTableArg) => {
       return dbTableArg.collectionName === nameArg;
     });
     return resultCollection;

ts/smartdata.classes.doc.ts

@@ -89,7 +89,7 @@ export class SmartDataDbDoc<T, TImplements> {
     }
   }
 
-  public static async getInstances<T>(filterArg): Promise<T[]> {
+  public static async getInstances<T>(filterArg: Partial<T>): Promise<T[]> {
     const self: any = this; // fool typesystem
     let referenceMongoDBCollection: SmartdataCollection<T>;
 
@@ -111,7 +111,7 @@ export class SmartDataDbDoc<T, TImplements> {
     return returnArray;
   }
 
-  public static async getInstance<T>(filterArg): Promise<T> {
+  public static async getInstance<T>(filterArg: Partial<T>): Promise<T> {
     const result = await this.getInstances<T>(filterArg);
     if (result && result.length > 0) {
       return result[0];

ts/smartdata.mongohelpers.ts

@@ -1,7 +0,0 @@
-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);
-};