@travetto/model-mongo 4.1.3 → 5.0.0-rc.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 ArcSine Technologies
+Copyright (c) 2023 ArcSine Technologies
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -48,7 +48,7 @@ where the [MongoModelConfig](https://github.com/travetto/travetto/tree/main/modu
 ```typescript
 import type mongo from 'mongodb';
 
-import { RuntimeResources, Env, TimeSpan } from '@travetto/base';
+import { RuntimeResources, Env, TimeSpan, TimeUtil } from '@travetto/base';
 import { Config } from '@travetto/config';
 import { Field } from '@travetto/schema';
 
@@ -152,7 +152,7 @@ export class MongoModelConfig {
     }
 
     if (!Env.production) {
-      opts.waitQueueTimeoutMS ??= 1000 * 60 * 60 * 24; // Wait a day in dev mode
+      opts.waitQueueTimeoutMS ??= TimeUtil.asMillis(1, 'd'); // Wait a day in dev mode
     }
   }
 
@@ -174,4 +174,4 @@ export class MongoModelConfig {
 }
 ```
 
-Additionally, you can see that the class is registered with the [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) annotation, and so these values can be overridden using the 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 [ResourceLoader](https://github.com/travetto/travetto/tree/main/module/base/src/resource.ts#L10) path or just a standard file path.
+Additionally, you can see that the class is registered with the [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) annotation, and so these values can be overridden using the 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 resource path (will attempt to lookup using [RuntimeResources](https://github.com/travetto/travetto/tree/main/module/base/src/resource.ts#L4)) or just a standard file path.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-mongo",
-  "version": "4.1.3",
+  "version": "5.0.0-rc.0",
   "description": "Mongo backing for the travetto model module.",
   "keywords": [
     "mongo",
@@ -25,13 +25,13 @@
     "directory": "module/model-mongo"
   },
   "dependencies": {
-    "@travetto/config": "^4.1.1",
-    "@travetto/model": "^4.1.3",
-    "@travetto/model-query": "^4.1.3",
-    "mongodb": "^6.7.0"
+    "@travetto/config": "^5.0.0-rc.0",
+    "@travetto/model": "^5.0.0-rc.0",
+    "@travetto/model-query": "^5.0.0-rc.0",
+    "mongodb": "^6.8.0"
   },
   "peerDependencies": {
-    "@travetto/command": "^4.1.1"
+    "@travetto/command": "^5.0.0-rc.0"
   },
   "peerDependenciesMeta": {
     "@travetto/command": {

package/src/config.ts

@@ -1,6 +1,6 @@
 import type mongo from 'mongodb';
 
-import { RuntimeResources, Env, TimeSpan } from '@travetto/base';
+import { RuntimeResources, Env, TimeSpan, TimeUtil } from '@travetto/base';
 import { Config } from '@travetto/config';
 import { Field } from '@travetto/schema';
 
@@ -104,7 +104,7 @@ export class MongoModelConfig {
     }
 
     if (!Env.production) {
-      opts.waitQueueTimeoutMS ??= 1000 * 60 * 60 * 24; // Wait a day in dev mode
+      opts.waitQueueTimeoutMS ??= TimeUtil.asMillis(1, 'd'); // Wait a day in dev mode
     }
   }
 

package/src/internal/util.ts

@@ -1,6 +1,6 @@
 import { Binary, ObjectId } from 'mongodb';
 
-import { Class, ObjectUtil } from '@travetto/base';
+import { Class } from '@travetto/base';
 import { DistanceUnit, ModelQuery, Query, WhereClause } from '@travetto/model-query';
 import type { ModelType, IndexField } from '@travetto/model';
 import { DataUtil, SchemaRegistry } from '@travetto/schema';
@@ -116,7 +116,7 @@ export class MongoUtil {
       return this.uuid(v);
     } else if (Array.isArray(v)) {
       return v.map(x => this.replaceId(x));
-    } else if (ObjectUtil.isPlainObject(v)) {
+    } else if (DataUtil.isPlainObject(v)) {
       const out: Record<string, Binary> = {};
       for (const [k, el] of Object.entries(v)) {
         const found = this.replaceId(el);
@@ -146,7 +146,7 @@ export class MongoUtil {
       if (subpath === 'id') { // Handle ids directly
         out._id = this.replaceId(v);
       } else {
-        const isPlain = v && ObjectUtil.isPlainObject(v);
+        const isPlain = v && DataUtil.isPlainObject(v);
         const firstKey = isPlain ? Object.keys(v)[0] : '';
 
         if ((isPlain && !firstKey.startsWith('$')) || v?.constructor?.Ⲑid) {

package/src/service.ts

@@ -11,14 +11,15 @@ import {
   ModelCrudSupport, ModelStorageSupport, ModelStreamSupport,
   ModelExpirySupport, ModelBulkSupport, ModelIndexedSupport,
   StreamMeta, BulkOp, BulkResponse,
-  NotFoundError, ExistsError, IndexConfig, PartialStream
+  NotFoundError, ExistsError, IndexConfig,
+  StreamRange
 } from '@travetto/model';
 import {
   ModelQuery, ModelQueryCrudSupport, ModelQueryFacetSupport, ModelQuerySupport,
   PageableModelQuery, ValidStringFields, WhereClause, ModelQuerySuggestSupport
 } from '@travetto/model-query';
 
-import { ShutdownManager, type Class, AppError, TypedObject, StreamUtil } from '@travetto/base';
+import { ShutdownManager, type Class, AppError, TypedObject } from '@travetto/base';
 import { Injectable } from '@travetto/di';
 import { DeepPartial, FieldConfig, SchemaRegistry, SchemaValidator } from '@travetto/schema';
 
@@ -30,7 +31,7 @@ import { ModelQuerySuggestUtil } from '@travetto/model-query/src/internal/servic
 import { PointImpl } from '@travetto/model-query/src/internal/model/point';
 import { ModelQueryExpiryUtil } from '@travetto/model-query/src/internal/service/expiry';
 import { ModelExpiryUtil } from '@travetto/model/src/internal/service/expiry';
-import { StreamModel, STREAMS } from '@travetto/model/src/internal/service/stream';
+import { enforceRange, StreamModel, STREAMS } from '@travetto/model/src/internal/service/stream';
 import { AllViewⲐ } from '@travetto/schema/src/internal/types';
 import { ModelBulkUtil } from '@travetto/model/src/internal/service/bulk';
 
@@ -299,26 +300,19 @@ export class MongoModelService implements
     await pipeline(input, writeStream);
   }
 
-  async getStream(location: string): Promise<Readable> {
-    await this.describeStream(location);
-
-    const res = await this.#bucket.openDownloadStreamByName(location);
-    if (!res) {
-      throw new NotFoundError(STREAMS, location);
-    }
-    return res;
-  }
-
-  async getStreamPartial(location: string, start: number, end?: number): Promise<PartialStream> {
+  async getStream(location: string, range?: StreamRange): Promise<Readable> {
     const meta = await this.describeStream(location);
 
-    [start, end] = StreamUtil.enforceRange(start, end, meta.size);
+    if (range) {
+      range = enforceRange(range, meta.size);
+      range.end! += 1; // range is exclusive
+    }
 
-    const res = await this.#bucket.openDownloadStreamByName(location, { start, end: end + 1 });
+    const res = await this.#bucket.openDownloadStreamByName(location, range);
     if (!res) {
       throw new NotFoundError(STREAMS, location);
     }
-    return { stream: res, range: [start, end] };
+    return res;
   }
 
   async describeStream(location: string): Promise<StreamMeta> {