@travetto/model-mongo 3.0.0-rc.9 → 3.0.1-rc.1

package/README.md

@@ -6,6 +6,10 @@
 **Install: @travetto/model-mongo**
 ```bash
 npm install @travetto/model-mongo
+
+# or
+
+yarn add @travetto/model-mongo
 ```
 
 This module provides an [mongodb](https://mongodb.com)-based implementation for the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.").  This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and query against [mongodb](https://mongodb.com).. Given the dynamic nature of [mongodb](https://mongodb.com), during development when models are modified, nothing needs to be done to adapt to the latest schema.
@@ -46,9 +50,9 @@ export class Init {
   
 **Code: Structure of MongoModelConfig**
 ```typescript
-import * as mongo from 'mongodb';
+import type mongo from 'mongodb';
 
-import { CommonFileResourceProvider, TimeSpan } from '@travetto/base';
+import { FileResourceProvider, TimeSpan } from '@travetto/base';
 import { Config } from '@travetto/config';
 import { Field } from '@travetto/schema';
 
@@ -90,8 +94,7 @@ export class MongoModelConfig {
    * Mongo client options
    */
   @Field(Object)
-  options: mongo.MongoClientOptions = {
-  };
+  options: mongo.MongoClientOptions = {};
 
   /**
    * Should we auto create the db
@@ -107,7 +110,7 @@ export class MongoModelConfig {
    * Load all the ssl certs as needed
    */
   async postConstruct(): Promise<void> {
-    const resources = new CommonFileResourceProvider();
+    const resources = new FileResourceProvider({ includeCommon: true });
     const resolve = (file: string): Promise<string> => resources.describe(file).then(({ path }) => path, () => file);
 
     const opts = this.options;
@@ -149,4 +152,4 @@ export class MongoModelConfig {
   standard [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Configuration support")resolution paths. 
   
 
-The SSL file options in `clientOptions` will automatically be resolved to files when given a path.  This path can be a [FileResourceProvider](https://github.com/travetto/travetto/tree/main/module/base/src/resource.ts#L40) path or just a standard file path.
+The SSL file options in `clientOptions` will automatically be resolved to files when given a path.  This path can be a [FileResourceProvider](https://github.com/travetto/travetto/tree/main/module/base/src/resource.ts#L46) path or just a standard file path.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-mongo",
-  "version": "3.0.0-rc.9",
+  "version": "3.0.1-rc.1",
   "description": "Mongo backing for the travetto model module.",
   "keywords": [
     "mongo",
@@ -25,13 +25,13 @@
     "directory": "module/model-mongo"
   },
   "dependencies": {
-    "@travetto/config": "^3.0.0-rc.9",
-    "@travetto/model": "^3.0.0-rc.9",
-    "@travetto/model-query": "^3.0.0-rc.9",
-    "mongodb": "^4.13.0"
+    "@travetto/config": "^3.0.1-rc.1",
+    "@travetto/model": "^3.0.1-rc.1",
+    "@travetto/model-query": "^3.0.1-rc.1",
+    "mongodb": "^5.0.1"
   },
   "peerDependencies": {
-    "@travetto/command": "^3.0.0-rc.7"
+    "@travetto/command": "^3.0.1-rc.1"
   },
   "peerDependenciesMeta": {
     "@travetto/command": {

package/src/config.ts

@@ -1,4 +1,4 @@
-import * as mongo from 'mongodb';
+import type mongo from 'mongodb';
 
 import { FileResourceProvider, TimeSpan } from '@travetto/base';
 import { Config } from '@travetto/config';
@@ -42,8 +42,7 @@ export class MongoModelConfig {
    * Mongo client options
    */
   @Field(Object)
-  options: mongo.MongoClientOptions = {
-  };
+  options: mongo.MongoClientOptions = {};
 
   /**
    * Should we auto create the db

package/src/internal/util.ts

@@ -49,7 +49,7 @@ export class MongoUtil {
     } else if (id instanceof mongo.ObjectId) {
       return id.toHexString();
     } else {
-      return id.buffer.toString('hex');
+      return Buffer.from(id.buffer).toString('hex');
     }
   }
 

package/src/service.ts

@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/consistent-type-assertions */
+// Wildcard import needed here due to packaging issues
 import * as mongo from 'mongodb';
 import { Readable } from 'stream';
 
@@ -194,6 +194,7 @@ export class MongoModelService implements
     if (!result.insertedId) {
       throw new ExistsError(cls, cleaned.id);
     }
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     delete (cleaned as { _id?: unknown })._id;
     return cleaned;
   }
@@ -245,9 +246,11 @@ export class MongoModelService implements
       .entries(items)
       .reduce<Record<string, unknown>>((acc, [k, v]) => {
         if (v === null || v === undefined) {
+          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
           const o = (acc.$unset ??= {}) as Record<string, unknown>;
           o[k] = v;
         } else {
+          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
           const o = (acc.$set ??= {}) as Record<string, unknown>;
           o[k] = v;
         }
@@ -347,6 +350,7 @@ export class MongoModelService implements
 
     for (const op of operations) {
       if (op.insert) {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         bulk.insert(MongoUtil.preInsertId(op.insert as T));
       } else if (op.upsert) {
         bulk.find({ _id: MongoUtil.uuid(op.upsert.id!) }).upsert().updateOne({ $set: op.upsert });
@@ -361,9 +365,11 @@ export class MongoModelService implements
 
     for (const op of operations) {
       if (op.insert) {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         MongoUtil.postLoadId(op.insert as T);
       }
     }
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     for (const { index, _id } of res.getUpsertedIds() as { index: number, _id: mongo.ObjectId }[]) {
       out.insertedIds.set(index, MongoUtil.idToString(_id));
     }
@@ -379,6 +385,7 @@ export class MongoModelService implements
       out.errors = res.getWriteErrors();
       for (const err of out.errors) {
         const op = operations[err.index];
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         const k = Object.keys(op)[0] as keyof BulkResponse['counts'];
         out.counts[k] -= 1;
       }
@@ -400,6 +407,7 @@ export class MongoModelService implements
     const result = await store.findOne(
       this.getWhere(
         cls,
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         ModelIndexedUtil.projectIndex(cls, idx, body) as WhereClause<T>
       )
     );
@@ -415,6 +423,7 @@ export class MongoModelService implements
     const result = await store.deleteOne(
       this.getWhere(
         cls,
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         ModelIndexedUtil.projectIndex(cls, idx, body) as WhereClause<T>
       )
     );
@@ -436,14 +445,17 @@ export class MongoModelService implements
       throw new AppError('Cannot list on unique indices', 'data');
     }
 
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     const where = this.getWhere(
       cls,
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       ModelIndexedUtil.projectIndex(cls, idx, body, { emptySortValue: { $exists: true } }) as WhereClause<T>
-    ) as mongo.Filter<T>;
+    ) as mongo.Filter<mongo.Document>;
 
     const cursor = store.find(where, { timeout: true }).batchSize(100).sort(asFielded(idxCfg)[IdxFieldsⲐ]);
 
     for await (const el of cursor) {
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       yield (await MongoUtil.postLoadId(await ModelCrudUtil.load(cls, el))) as T;
     }
   }
@@ -505,9 +517,11 @@ export class MongoModelService implements
     const items = MongoUtil.extractSimple(data);
     const final = Object.entries(items).reduce<Record<string, unknown>>((acc, [k, v]) => {
       if (v === null || v === undefined) {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         const o = (acc.$unset = acc.$unset ?? {}) as Record<string, unknown>;
         o[k] = v;
       } else {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         const o = (acc.$set = acc.$set ?? {}) as Record<string, unknown>;
         o[k] = v;
       }
@@ -524,6 +538,7 @@ export class MongoModelService implements
     const col = await this.getStore(cls);
     const pipeline: object[] = [{
       $group: {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         _id: `$${field as string}`,
         count: {
           $sum: 1
@@ -539,6 +554,7 @@ export class MongoModelService implements
 
     pipeline.unshift({ $match: q });
 
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     const result = (await col.aggregate(pipeline).toArray()) as { _id: mongo.ObjectId, count: number }[];
 
     return result.map(val => ({

package/support/service.mongo.ts

@@ -1,9 +1,9 @@
 import { Env } from '@travetto/base';
-import type { Service } from '@travetto/command/support/bin/service';
+import type { CommandService } from '@travetto/command';
 
-const version = Env.get('MONGO_VERSION', '4.4');
+const version = Env.get('MONGO_VERSION', '6.0');
 
-export const service: Service = {
+export const service: CommandService = {
   name: 'mongodb',
   version,
   port: 27017,