@travetto/model-mongo 6.0.0-rc.0 → 6.0.0-rc.2

package/README.md

@@ -16,15 +16,15 @@ 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. 
 
 Supported features:
-   *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/crud.ts#L11)
-   *  [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11)
-   *  [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/service/bulk.ts#L19)
-   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model/src/service/indexed.ts#L12)
-   *  [Blob](https://github.com/travetto/travetto/tree/main/module/model/src/service/blob.ts#L8)
-   *  [Query Crud](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/crud.ts#L11)
-   *  [Facet](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/facet.ts#L12)
-   *  [Query](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/query.ts#L10)
-   *  [Suggest](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/suggest.ts#L12)
+   *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L11)
+   *  [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/types/expiry.ts#L10)
+   *  [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/types/bulk.ts#L64)
+   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model/src/types/indexed.ts#L11)
+   *  [Blob](https://github.com/travetto/travetto/tree/main/module/model/src/types/blob.ts#L8)
+   *  [Query Crud](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/crud.ts#L11)
+   *  [Facet](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/facet.ts#L14)
+   *  [Query](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/query.ts#L10)
+   *  [Suggest](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/suggest.ts#L12)
 Out of the box, by installing the module, everything should be wired up by default.If you need to customize any aspect of the source or config, you can override and register it with the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") module.
 
 **Code: Wiring up a custom Model Source**
@@ -46,15 +46,6 @@ where the [MongoModelConfig](https://github.com/travetto/travetto/tree/main/modu
 
 **Code: Structure of MongoModelConfig**
 ```typescript
-import type mongo from 'mongodb';
-
-import { TimeSpan, TimeUtil, RuntimeResources, Runtime } from '@travetto/runtime';
-import { Config } from '@travetto/config';
-import { Field } from '@travetto/schema';
-
-/**
- * Mongo model config
- */
 @Config('model.mongo')
 export class MongoModelConfig {
   /**

package/__index__.ts

@@ -1,2 +1,2 @@
-export * from './src/service';
-export * from './src/config';
+export * from './src/service.ts';
+export * from './src/config.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-mongo",
-  "version": "6.0.0-rc.0",
+  "version": "6.0.0-rc.2",
   "description": "Mongo backing for the travetto model module.",
   "keywords": [
     "mongo",
@@ -25,11 +25,11 @@
     "directory": "module/model-mongo"
   },
   "dependencies": {
-    "@travetto/cli": "^6.0.0-rc.0",
-    "@travetto/config": "^6.0.0-rc.0",
-    "@travetto/model": "^6.0.0-rc.0",
-    "@travetto/model-query": "^6.0.0-rc.0",
-    "mongodb": "^6.12.0"
+    "@travetto/cli": "^6.0.0-rc.2",
+    "@travetto/config": "^6.0.0-rc.2",
+    "@travetto/model": "^6.0.0-rc.2",
+    "@travetto/model-query": "^6.0.0-rc.2",
+    "mongodb": "^6.16.0"
   },
   "travetto": {
     "displayName": "MongoDB Model Support"

package/src/internal/util.ts

@@ -2,14 +2,12 @@ import {
   Binary, type CreateIndexesOptions, type Filter, type FindCursor, type IndexDirection, ObjectId, type WithId as MongoWithId
 } from 'mongodb';
 
-import { AppError, castTo, Class, TypedObject } from '@travetto/runtime';
-import type { DistanceUnit, PageableModelQuery, WhereClause } from '@travetto/model-query';
+import { AppError, castTo, Class, toConcrete, TypedObject } from '@travetto/runtime';
+import { type DistanceUnit, type PageableModelQuery, type WhereClause, ModelQueryUtil } from '@travetto/model-query';
 import type { ModelType, IndexField, IndexConfig } from '@travetto/model';
-import { DataUtil, SchemaRegistry } from '@travetto/schema';
+import { DataUtil, SchemaRegistry, type Point } from '@travetto/schema';
 
-import { ModelQueryUtil } from '@travetto/model-query/src/internal/service/query';
-import { AllViewSymbol } from '@travetto/schema/src/internal/types';
-import { PointImpl } from '@travetto/model-query/src/internal/model/point';
+const PointImpl = toConcrete<Point>();
 
 type IdxCfg = CreateIndexesOptions;
 
@@ -89,7 +87,7 @@ export class MongoUtil {
     for (const key of keys) {
       const subpath = `${path}${key}`;
       const v: Record<string, unknown> = castTo(sub[key]);
-      const subField = schema?.views[AllViewSymbol].schema[key];
+      const subField = schema?.totalView.schema[key];
 
       const isPlain = v && DataUtil.isPlainObject(v);
       const firstKey = isPlain ? Object.keys(v)[0] : '';

package/src/service.ts

@@ -9,12 +9,14 @@ import {
 import {
   ModelRegistry, ModelType, OptionalId, ModelCrudSupport, ModelStorageSupport,
   ModelExpirySupport, ModelBulkSupport, ModelIndexedSupport, BulkOp, BulkResponse,
-  NotFoundError, ExistsError, ModelBlobSupport
+  NotFoundError, ExistsError, ModelBlobSupport,
+  ModelCrudUtil, ModelIndexedUtil, ModelStorageUtil, ModelExpiryUtil, ModelBulkUtil, ModelBlobUtil,
 } from '@travetto/model';
 import {
   ModelQuery, ModelQueryCrudSupport, ModelQueryFacetSupport, ModelQuerySupport,
   PageableModelQuery, ValidStringFields, WhereClause, ModelQuerySuggestSupport,
-  QueryVerifier
+  QueryVerifier, ModelQueryUtil, ModelQuerySuggestUtil, ModelQueryCrudUtil,
+  ModelQueryFacet,
 } from '@travetto/model-query';
 
 import {
@@ -23,25 +25,17 @@ import {
 } from '@travetto/runtime';
 import { Injectable } from '@travetto/di';
 
-import { ModelCrudUtil } from '@travetto/model/src/internal/service/crud';
-import { ModelIndexedUtil } from '@travetto/model/src/internal/service/indexed';
-import { ModelStorageUtil } from '@travetto/model/src/internal/service/storage';
-import { ModelQueryUtil } from '@travetto/model-query/src/internal/service/query';
-import { ModelQuerySuggestUtil } from '@travetto/model-query/src/internal/service/suggest';
-import { ModelQueryExpiryUtil } from '@travetto/model-query/src/internal/service/expiry';
-import { ModelExpiryUtil } from '@travetto/model/src/internal/service/expiry';
-import { ModelBulkUtil } from '@travetto/model/src/internal/service/bulk';
-import { MODEL_BLOB, ModelBlobNamespace, ModelBlobUtil } from '@travetto/model/src/internal/service/blob';
+import { MongoUtil, PlainIdx, WithId } from './internal/util.ts';
+import { MongoModelConfig } from './config.ts';
 
-import { MongoUtil, PlainIdx, WithId } from './internal/util';
-import { MongoModelConfig } from './config';
-
-const ListIndexSymbol = Symbol.for('@travetto/mongo-model:list-index');
+const ListIndexSymbol = Symbol();
 
 type BlobRaw = GridFSFile & { metadata?: BlobMeta };
 
 type MongoTextSearch = RootFilterOperators<unknown>['$text'];
 
+export const ModelBlobNamespace = '__blobs';
+
 /**
  * Mongo-based model source
  */
@@ -152,12 +146,12 @@ export class MongoModelService implements
   }
 
   async truncateModel<T extends ModelType>(cls: Class<T>): Promise<void> {
-    if (cls === MODEL_BLOB) {
-      await this.#bucket.drop().catch(() => { });
-    } else {
-      const col = await this.getStore(cls);
-      await col.deleteMany({});
-    }
+    const col = await this.getStore(cls);
+    await col.deleteMany({});
+  }
+
+  async truncateBlob(): Promise<void> {
+    await this.#bucket.drop().catch(() => { });
   }
 
   /**
@@ -172,9 +166,9 @@ export class MongoModelService implements
     const store = await this.getStore(cls);
     const result = await store.findOne(this.getIdFilter(cls, id), {});
     if (result) {
-      const res = await this.postLoad(cls, result);
-      if (res) {
-        return res;
+      const finalized = await this.postLoad(cls, result);
+      if (finalized) {
+        return finalized;
       }
     }
     throw new NotFoundError(cls, id);
@@ -196,8 +190,8 @@ export class MongoModelService implements
     item = await ModelCrudUtil.preStore(cls, item, this);
     const id = this.preUpdate(item);
     const store = await this.getStore(cls);
-    const res = await store.replaceOne(this.getIdFilter(cls, id), item);
-    if (res.matchedCount === 0) {
+    const result = await store.replaceOne(this.getIdFilter(cls, id), item);
+    if (result.matchedCount === 0) {
       throw new NotFoundError(cls, id);
     }
     return this.postUpdate(item, id);
@@ -243,13 +237,13 @@ export class MongoModelService implements
 
     const id = item.id;
 
-    const res = await store.findOneAndUpdate(
+    const result = await store.findOneAndUpdate(
       this.getIdFilter(cls, id),
       operation,
       { returnDocument: 'after', includeResultMetadata: true }
     );
 
-    if (!res.value) {
+    if (!result.value) {
       throw new NotFoundError(cls, id);
     }
 
@@ -305,8 +299,8 @@ export class MongoModelService implements
   }
 
   async getBlobMeta(location: string): Promise<BlobMeta> {
-    const res = await this.#db.collection<{ metadata: BlobMeta }>(`${ModelBlobNamespace}.files`).findOne({ filename: location });
-    return res!.metadata;
+    const result = await this.#db.collection<{ metadata: BlobMeta }>(`${ModelBlobNamespace}.files`).findOne({ filename: location });
+    return result!.metadata;
   }
 
   async deleteBlob(location: string): Promise<void> {
@@ -360,7 +354,7 @@ export class MongoModelService implements
       }
     }
 
-    const res = await bulk.execute({});
+    const result = await bulk.execute({});
 
     // Restore all ids
     for (const op of operations) {
@@ -370,19 +364,19 @@ export class MongoModelService implements
       }
     }
 
-    for (const [index, _id] of TypedObject.entries<Record<string, string>>(res.upsertedIds)) {
+    for (const [index, _id] of TypedObject.entries<Record<string, string>>(result.upsertedIds)) {
       out.insertedIds.set(+index, MongoUtil.idToString(_id));
     }
 
     if (out.counts) {
-      out.counts.delete = res.deletedCount;
+      out.counts.delete = result.deletedCount;
       out.counts.update = operations.filter(x => x.update).length;
-      out.counts.insert = res.insertedCount;
+      out.counts.insert = result.insertedCount;
       out.counts.upsert = operations.filter(x => x.upsert).length;
     }
 
-    if (res.hasWriteErrors()) {
-      out.errors = res.getWriteErrors();
+    if (result.hasWriteErrors()) {
+      out.errors = result.getWriteErrors();
       for (const err of out.errors) {
         const op = operations[err.index];
         const k = TypedObject.keys(op)[0];
@@ -396,7 +390,7 @@ export class MongoModelService implements
 
   // Expiry
   deleteExpired<T extends ModelType>(cls: Class<T>): Promise<number> {
-    return ModelQueryExpiryUtil.deleteExpired(this, cls);
+    return ModelQueryCrudUtil.deleteExpired(this, cls);
   }
 
   // Indexed
@@ -486,8 +480,8 @@ export class MongoModelService implements
     where.id = id;
 
     const filter = MongoUtil.extractWhereFilter(cls, where);
-    const res = await col.replaceOne(filter, item);
-    if (res.matchedCount === 0) {
+    const result = await col.replaceOne(filter, item);
+    if (result.matchedCount === 0) {
       throw new NotFoundError(cls, id);
     }
     return this.postUpdate(item, id);
@@ -498,8 +492,8 @@ export class MongoModelService implements
 
     const col = await this.getStore(cls);
     const filter = MongoUtil.extractWhereFilter(cls, query.where, false);
-    const res = await col.deleteMany(filter);
-    return res.deletedCount ?? 0;
+    const result = await col.deleteMany(filter);
+    return result.deletedCount ?? 0;
   }
 
   async updatePartialByQuery<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, data: Partial<T>): Promise<number> {
@@ -519,12 +513,12 @@ export class MongoModelService implements
       }, {});
 
     const filter = MongoUtil.extractWhereFilter(cls, query.where);
-    const res = await col.updateMany(filter, castTo(final));
-    return res.matchedCount;
+    const result = await col.updateMany(filter, castTo(final));
+    return result.matchedCount;
   }
 
   // Facet
-  async facet<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, query?: ModelQuery<T>): Promise<{ key: string, count: number }[]> {
+  async facet<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, query?: ModelQuery<T>): Promise<ModelQueryFacet[]> {
     await QueryVerifier.verify(cls, query);
 
     const col = await this.getStore(cls);
@@ -552,10 +546,12 @@ export class MongoModelService implements
 
     const result = await col.aggregate<{ _id: ObjectId, count: number }>(aggregations).toArray();
 
-    return result.map(val => ({
-      key: MongoUtil.idToString(val._id),
-      count: val.count
-    })).sort((a, b) => b.count - a.count);
+    return result
+      .map(val => ({
+        key: MongoUtil.idToString(val._id),
+        count: val.count
+      }))
+      .toSorted((a, b) => b.count - a.count);
   }
 
   // Suggest