5.0.10

.gitlab-ci.yml

@@ -13,31 +13,24 @@ stages:
   - metadata
 
 before_script:
-  - npm install -g @shipzone/npmci
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
 
 # ====================
 # security stage
 # ====================
-mirror:
+# ====================
-  stage: security
+# security stage
-  script:
+# ====================
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
 auditProductionDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
+     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm install --production --ignore-scripts
+     - npmci command pnpm audit --audit-level=high --prod
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -45,11 +38,10 @@ 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 --only=dev
+    - npmci command pnpm audit --audit-level=high --dev
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -60,7 +52,6 @@ auditDevDependencies:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
@@ -71,7 +62,6 @@ testStable:
 testBuild:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci command npm run build
@@ -100,10 +90,9 @@ codequality:
   only:
     - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -123,11 +112,9 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
+    - npmci node install stable
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

npmextra.json

@@ -15,7 +15,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartdata",
-      "shortDescription": "do more with data",
+      "description": "do more with data",
       "npmPackagename": "@pushrocks/smartdata",
       "license": "MIT"
     }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartdata",
-  "version": "5.0.2",
+  "version": "5.0.10",
   "private": false,
   "description": "do more with data",
   "main": "dist_ts/index.js",
@@ -8,7 +8,8 @@
   "type": "module",
   "scripts": {
     "test": "tstest test/",
-    "build": "tsbuild --web --allowimplicitany"
+    "build": "tsbuild --web --allowimplicitany",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -21,26 +22,26 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartdata#README",
   "dependencies": {
-    "@pushrocks/lik": "^5.0.4",
+    "@pushrocks/lik": "^6.0.0",
     "@pushrocks/smartdelay": "^2.0.13",
-    "@pushrocks/smartlog": "^2.0.44",
+    "@pushrocks/smartlog": "^3.0.1",
-    "@pushrocks/smartmongo": "^2.0.1",
+    "@pushrocks/smartmongo": "^2.0.7",
     "@pushrocks/smartpromise": "^3.1.7",
-    "@pushrocks/smartrx": "^2.0.25",
+    "@pushrocks/smartrx": "^3.0.0",
     "@pushrocks/smartstring": "^4.0.2",
     "@pushrocks/smartunique": "^3.0.3",
-    "@tsclass/tsclass": "^4.0.2",
+    "@tsclass/tsclass": "^4.0.19",
-    "@types/lodash": "^4.14.182",
+    "@types/lodash": "^4.14.188",
-    "@types/mongodb": "^4.0.7",
     "lodash": "^4.17.21",
-    "mongodb": "^4.6.0"
+    "mongodb": "^4.9.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.61",
+    "@gitzone/tsbuild": "^2.1.65",
-    "@gitzone/tstest": "^1.0.71",
+    "@gitzone/tsrun": "^1.2.37",
-    "@pushrocks/qenv": "^4.0.10",
+    "@gitzone/tstest": "^1.0.74",
-    "@pushrocks/tapbundle": "^5.0.3",
+    "@pushrocks/qenv": "^5.0.2",
-    "@types/node": "^17.0.34",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.7.16",
     "@types/shortid": "0.0.29"
   },
   "files": [

test/test.ts

@@ -3,6 +3,8 @@ import { Qenv } from '@pushrocks/qenv';
 import * as smartmongo from '@pushrocks/smartmongo';
 import { smartunique } from '../ts/smartdata.plugins.js';
 
+import * as mongodb from 'mongodb';
+
 const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/');
 
 console.log(process.memoryUsage());
@@ -55,6 +57,9 @@ class Car extends smartdata.SmartDataDbDoc<Car, Car> {
   @smartdata.svDb()
   public brand: string;
 
+  @smartdata.svDb()
+  public testBuffer = Buffer.from('hello');
+
   @smartdata.svDb()
   deepData = {
     sodeep: 'yes',
@@ -67,7 +72,7 @@ class Car extends smartdata.SmartDataDbDoc<Car, Car> {
   }
 }
 
-tap.test('should save the car to the db', async () => {
+tap.test('should save the car to the db', async (toolsArg) => {
   const myCar = new Car('red', 'Volvo');
   await myCar.save();
 
@@ -75,6 +80,9 @@ tap.test('should save the car to the db', async () => {
   await myCar2.save();
 
   let counter = 0;
+
+  const gottenCarInstance = await Car.getInstance({});
+  console.log(gottenCarInstance.testBuffer instanceof mongodb.Binary);
   process.memoryUsage();
   do {
     const myCar3 = new Car('red', 'Renault');

test/test.watch.ts

@@ -42,14 +42,14 @@ class House extends smartdata.SmartDataDbDoc<House, House> {
   @smartdata.svDb()
   public data = {
     id: smartunique.shortId(),
-    hello: 'hello'
+    hello: 'hello',
-  }
+  };
 }
 
 tap.test('should watch a collection', async (toolsArg) => {
   const done = toolsArg.defer();
   const watcher = await House.watch({});
-  watcher.changeSubject.subscribe(async houseArg => {
+  watcher.changeSubject.subscribe(async (houseArg) => {
     console.log('hey there, we observed a house');
     await watcher.close();
     done.resolve();
@@ -58,7 +58,7 @@ tap.test('should watch a collection', async (toolsArg) => {
   await newHouse.save();
   console.log('saved a house');
   await done.promise;
-})
+});
 
 // =======================================
 // close the database connection
@@ -71,4 +71,4 @@ tap.test('close', async () => {
   }
 });
 
-tap.start({ throwOnError: true });
+tap.start({ throwOnError: true });

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@pushrocks/smartdata',
-  version: '5.0.2',
+  version: '5.0.10',
   description: 'do more with data'
 }

ts/index.ts

@@ -4,4 +4,7 @@ export * from './smartdata.classes.doc.js';
 export * from './smartdata.classes.easystore.js';
 export * from './smartdata.classes.cursor.js';
 
-export type { IMongoDescriptor } from './interfaces/index.js';
+// to be removed with the next breaking update
+import * as plugins from './smartdata.plugins.js';
+type IMongoDescriptor = plugins.tsclass.database.IMongoDescriptor;
+export type { IMongoDescriptor };

ts/interfaces/index.ts

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

ts/interfaces/mongodescriptor.ts

@@ -1,22 +0,0 @@
-export interface IMongoDescriptor {
-  /**
-   * the URL to connect to
-   */
-  mongoDbUrl: 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

@@ -109,7 +109,6 @@ export function Manager<TManager extends IManager>(managerArg?: TManager | TDela
   };
 }
 
-// tslint:disable-next-line: max-classes-per-file
 export class SmartdataCollection<T> {
   /**
    * the collection that is used
@@ -180,7 +179,10 @@ export class SmartdataCollection<T> {
     return result;
   }
 
-  public async getCursor(filterObjectArg: any, dbDocArg: typeof SmartDataDbDoc): Promise<SmartdataDbCursor<any>> {
+  public async getCursor(
+    filterObjectArg: any,
+    dbDocArg: typeof SmartDataDbDoc
+  ): Promise<SmartdataDbCursor<any>> {
     await this.init();
     const cursor = this.mongoDbCollection.find(filterObjectArg);
     return new SmartdataDbCursor(cursor, dbDocArg);
@@ -200,16 +202,22 @@ export class SmartdataCollection<T> {
   /**
    * watches the collection while applying a filter
    */
-   public async watch(filterObject: any, smartdataDbDocArg: typeof SmartDataDbDoc): Promise<SmartdataDbWatcher> {
+  public async watch(
+    filterObject: any,
+    smartdataDbDocArg: typeof SmartDataDbDoc
+  ): Promise<SmartdataDbWatcher> {
     await this.init();
-    const changeStream = this.mongoDbCollection.watch([
+    const changeStream = this.mongoDbCollection.watch(
+      [
+        {
+          $match: filterObject,
+        },
+      ],
       {
-        $match: filterObject
+        fullDocument: 'updateLookup',
       }
-    ], {
+    );
-      fullDocument: 'updateLookup'
+    const smartdataWatcher = new SmartdataDbWatcher(changeStream, smartdataDbDocArg);
-    });
-    const smartdataWatcher =  new SmartdataDbWatcher(changeStream, smartdataDbDocArg);
     await smartdataWatcher.readyDeferred.promise;
     return smartdataWatcher;
   }

ts/smartdata.classes.cursor.ts

@@ -16,20 +16,23 @@ export class SmartdataDbCursor<T = any> {
   }
 
   public async next(closeAtEnd = true) {
-    const result = this.smartdataDbDoc.createInstanceFromMongoDbNativeDoc(await this.mongodbCursor.next());
+    const result = this.smartdataDbDoc.createInstanceFromMongoDbNativeDoc(
+      await this.mongodbCursor.next()
+    );
     if (!result && closeAtEnd) {
       await this.close();
     }
     return result;
   }
 
-  public async forEach(forEachFuncArg: (itemArg: any) => Promise<any>, closeCursorAtEnd = true) {
+  public async forEach(forEachFuncArg: (itemArg: T) => Promise<any>, closeCursorAtEnd = true) {
     let nextDocument: any;
     do {
       nextDocument = await this.mongodbCursor.next();
       if (nextDocument) {
-        const nextClassInstance = this.smartdataDbDoc.createInstanceFromMongoDbNativeDoc(nextDocument);
+        const nextClassInstance =
-        await forEachFuncArg(nextClassInstance);
+          this.smartdataDbDoc.createInstanceFromMongoDbNativeDoc(nextDocument);
+        await forEachFuncArg(nextClassInstance as any);
       }
     } while (nextDocument);
     if (closeCursorAtEnd) {

ts/smartdata.classes.db.ts

@@ -5,7 +5,6 @@ import { SmartdataCollection } from './smartdata.classes.collection.js';
 import { EasyStore } from './smartdata.classes.easystore.js';
 
 import { logger } from './smartdata.logging.js';
-import { IMongoDescriptor } from './interfaces/index.js';
 
 /**
  * interface - indicates the connection status of the db
@@ -13,13 +12,13 @@ import { IMongoDescriptor } from './interfaces/index.js';
 export type TConnectionStatus = 'initial' | 'disconnected' | 'connected' | 'failed';
 
 export class SmartdataDb {
-  smartdataOptions: IMongoDescriptor;
+  smartdataOptions: plugins.tsclass.database.IMongoDescriptor;
   mongoDbClient: plugins.mongodb.MongoClient;
   mongoDb: plugins.mongodb.Db;
   status: TConnectionStatus;
   smartdataCollectionMap = new ObjectMap<SmartdataCollection<any>>();
 
-  constructor(smartdataOptions: IMongoDescriptor) {
+  constructor(smartdataOptions: plugins.tsclass.database.IMongoDescriptor) {
     this.smartdataOptions = smartdataOptions;
     this.status = 'initial';
   }

ts/smartdata.classes.doc.ts

@@ -147,18 +147,18 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
 
   /**
    * watch the collection
-   * @param this 
+   * @param this
-   * @param filterArg 
+   * @param filterArg
-   * @param forEachFunction 
+   * @param forEachFunction
    */
-   public static async watch<T>(
+  public static async watch<T>(
     this: plugins.tsclass.typeFest.Class<T>,
     filterArg: plugins.tsclass.typeFest.PartialDeep<T>
   ) {
     const collection: SmartdataCollection<T> = (this as any).collection;
     const watcher: SmartdataDbWatcher<T> = await collection.watch(
       convertFilterForMongoDb(filterArg),
-      (this as any)
+      this as any
     );
     return watcher;
   }

ts/smartdata.classes.watcher.ts

@@ -11,12 +11,17 @@ export class SmartdataDbWatcher<T = any> {
   // INSTANCE
   private changeStream: plugins.mongodb.ChangeStream<T>;
 
-  public changeSubject = new plugins.smartrx.rxjs.Subject<SmartDataDbDoc<T, T>>();
+  public changeSubject = new plugins.smartrx.rxjs.Subject<T>();
-  constructor(changeStreamArg: plugins.mongodb.ChangeStream<T>, smartdataDbDocArg: typeof SmartDataDbDoc) {
+  constructor(
+    changeStreamArg: plugins.mongodb.ChangeStream<T>,
+    smartdataDbDocArg: typeof SmartDataDbDoc
+  ) {
     this.changeStream = changeStreamArg;
     this.changeStream.on('change', async (item: T) => {
-      this.changeSubject.next(smartdataDbDocArg.createInstanceFromMongoDbNativeDoc(item));
+      this.changeSubject.next(
-    })
+        smartdataDbDocArg.createInstanceFromMongoDbNativeDoc(item) as any as T
+      );
+    });
     plugins.smartdelay.delayFor(0).then(() => {
       this.readyDeferred.resolve();
     });

ts/smartdata.plugins.ts

@@ -7,11 +7,21 @@ export { tsclass };
 import * as smartlog from '@pushrocks/smartlog';
 import * as lodash from 'lodash';
 import * as mongodb from 'mongodb';
-import * as smartdelay from '@pushrocks/smartdelay'
+import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartq from '@pushrocks/smartpromise';
 import * as smartrx from '@pushrocks/smartrx';
 import * as smartstring from '@pushrocks/smartstring';
 import * as smartunique from '@pushrocks/smartunique';
 
-export { smartdelay, smartpromise, smartlog, lodash, smartq, smartrx, mongodb, smartstring, smartunique };
+export {
+  smartdelay,
+  smartpromise,
+  smartlog,
+  lodash,
+  smartq,
+  smartrx,
+  mongodb,
+  smartstring,
+  smartunique,
+};