monsqlize 3.1.14 → 3.3.0

package/dist/types/monsqlize.d.mts

@@ -35,7 +35,7 @@ export interface SSHConfig {
 import type { Collection, CursorValueNormalizer, CursorValueType, DbAccessor, HealthView } from './collection.mjs';
 import type { DataTaskJobError } from './data-tasks.mjs';
 import type { Lock, LockOptions, LockStats } from './lock.mjs';
-import type { ModelAutoIndexOptions, ModelEnsureAllIndexesOptions, ModelIndexEnsureSummary, ModelInstance } from './model.mjs';
+import type { ModelAutoIndexOptions, ModelDescriptor, ModelEnsureAllIndexesOptions, ModelIndexEnsureSummary, ModelInstance } from './model.mjs';
 import type { MongoConnectConfig } from './mongodb.mjs';
 import type { ConnectionPoolManagerOptions, PoolConfig, PoolHealthStatus, PoolStats, PoolStrategy } from './pool.mjs';
 import type {
@@ -70,6 +70,15 @@ import type { SlowQueryLogConfigInput, SlowQueryLogEntry, SlowQueryLogFilter, Sl
 import type { ChangeStreamSyncManager, SyncConfig, SyncStats } from './sync.mjs';
 import type { Transaction, TransactionOptions, TransactionStats } from './transaction.mjs';
 
+/**
+ * Callable model accessor that preserves a descriptor's inferred document type.
+ * @since v3.3.0
+ */
+export interface ModelBindingAccessor {
+    <TDocument>(descriptor: ModelDescriptor<string, TDocument>): ModelInstance<TDocument>;
+    <TDocument = any>(modelName: string): ModelInstance<TDocument>;
+}
+
 /** Write path policy mode. `allow-both` preserves the existing collection and model write behavior. */
 export type WritePathPolicyMode = 'allow-both' | 'model-only';
 
@@ -283,7 +292,7 @@ export interface MonSQLizeInstance {
         db: (name?: string) => DbAccessor;
         use: (name: string) => {
             collection: <TSchema = any>(collectionName: string) => Collection<TSchema>;
-            model: <TDocument = any>(modelName: string) => ModelInstance<TDocument>;
+            model: ModelBindingAccessor;
         };
         instance: MonSQLize;
     }>;
@@ -315,7 +324,7 @@ export interface MonSQLizeInstance {
      */
     use(name: string): {
         collection: <TSchema = any>(collectionName: string) => Collection<TSchema>;
-        model: <TDocument = any>(modelName: string) => ModelInstance<TDocument>;
+        model: ModelBindingAccessor;
     };
     /**
      * Return collection and model accessors for the named connection pool.
@@ -323,10 +332,10 @@ export interface MonSQLizeInstance {
      */
     pool(poolName: string): {
         collection: <TSchema = any>(name: string) => Collection<TSchema>;
-        model: <TDocument = any>(name: string) => ModelInstance<TDocument>;
+        model: ModelBindingAccessor;
         use: (dbName: string) => {
             collection: <TSchema = any>(name: string) => Collection<TSchema>;
-            model: <TDocument = any>(name: string) => ModelInstance<TDocument>;
+            model: ModelBindingAccessor;
         };
     };
     /**
@@ -341,12 +350,16 @@ export interface MonSQLizeInstance {
      * @param name Model name.
      * @param options Optional database or pool scope options.
      */
+    /** @since v3.3.0 */
+    scopedModel<TDocument>(descriptor: ModelDescriptor<string, TDocument>, options?: { database?: string; pool?: string; }): ModelInstance<TDocument>;
     scopedModel<TDocument = any>(name: string, options?: { database?: string; pool?: string; }): ModelInstance<TDocument>;
     scopedModel(name: string, options?: { database?: string; pool?: string; }): ModelInstance<any>;
     /**
      * Return the registered model instance for the given model name.
      * @param name Model name used during registration.
      */
+    /** @since v3.3.0 */
+    model<TDocument>(descriptor: ModelDescriptor<string, TDocument>): ModelInstance<TDocument>;
     model<TDocument = any>(name: string): ModelInstance<TDocument>;
     model(name: string): ModelInstance<any>;
     /**
@@ -516,7 +529,7 @@ export default class MonSQLize implements MonSQLizeInstance {
         db: (name?: string) => DbAccessor;
         use: (name: string) => {
             collection: <TSchema = any>(collectionName: string) => Collection<TSchema>;
-            model: <TDocument = any>(modelName: string) => ModelInstance<TDocument>;
+            model: ModelBindingAccessor;
         };
         instance: MonSQLize;
     }>;
@@ -529,20 +542,24 @@ export default class MonSQLize implements MonSQLizeInstance {
     db(name?: string): DbAccessor;
     use(name: string): {
         collection: <TSchema = any>(collectionName: string) => Collection<TSchema>;
-        model: <TDocument = any>(modelName: string) => ModelInstance<TDocument>;
+        model: ModelBindingAccessor;
     };
     pool(poolName: string): {
         collection: <TSchema = any>(name: string) => Collection<TSchema>;
-        model: <TDocument = any>(name: string) => ModelInstance<TDocument>;
+        model: ModelBindingAccessor;
         use: (dbName: string) => {
             collection: <TSchema = any>(name: string) => Collection<TSchema>;
-            model: <TDocument = any>(name: string) => ModelInstance<TDocument>;
+            model: ModelBindingAccessor;
         };
     };
     scopedCollection<TSchema = any>(name: string, options?: { database?: string; pool?: string; }): Collection<TSchema>;
     scopedCollection(name: string, options?: { database?: string; pool?: string; }): Collection<any>;
+    /** @since v3.3.0 */
+    scopedModel<TDocument>(descriptor: ModelDescriptor<string, TDocument>, options?: { database?: string; pool?: string; }): ModelInstance<TDocument>;
     scopedModel<TDocument = any>(name: string, options?: { database?: string; pool?: string; }): ModelInstance<TDocument>;
     scopedModel(name: string, options?: { database?: string; pool?: string; }): ModelInstance<any>;
+    /** @since v3.3.0 */
+    model<TDocument>(descriptor: ModelDescriptor<string, TDocument>): ModelInstance<TDocument>;
     model<TDocument = any>(name: string): ModelInstance<TDocument>;
     model(name: string): ModelInstance<any>;
     ensureModelIndexes(options?: ModelEnsureAllIndexesOptions): Promise<ModelIndexEnsureSummary>;
@@ -601,6 +618,8 @@ export default class MonSQLize implements MonSQLizeInstance {
     static LockTimeoutError: typeof import('./lock.mjs').LockTimeoutError;
     static DistributedCacheInvalidator: typeof DistributedCacheInvalidator;
     static ConnectionPoolManager: typeof import('./pool.mjs').ConnectionPoolManager;
+    /** @since v3.3.0 */
+    static defineModel: typeof import('./model.mjs').defineModel;
     static Model: typeof import('./runtime.mjs').Model;
     static ModelInstance: typeof import('./runtime.mjs').ModelInstance;
     static expr: typeof expr;

package/dist/types/monsqlize.d.ts

@@ -35,7 +35,7 @@ export interface SSHConfig {
 import type { Collection, CursorValueNormalizer, CursorValueType, DbAccessor, HealthView } from './collection';
 import type { DataTaskJobError } from './data-tasks';
 import type { Lock, LockOptions, LockStats } from './lock';
-import type { ModelAutoIndexOptions, ModelEnsureAllIndexesOptions, ModelIndexEnsureSummary, ModelInstance } from './model';
+import type { ModelAutoIndexOptions, ModelDescriptor, ModelEnsureAllIndexesOptions, ModelIndexEnsureSummary, ModelInstance } from './model';
 import type { MongoConnectConfig } from './mongodb';
 import type { ConnectionPoolManagerOptions, PoolConfig, PoolHealthStatus, PoolStats, PoolStrategy } from './pool';
 import type {
@@ -70,6 +70,15 @@ import type { SlowQueryLogConfigInput, SlowQueryLogEntry, SlowQueryLogFilter, Sl
 import type { ChangeStreamSyncManager, SyncConfig, SyncStats } from './sync';
 import type { Transaction, TransactionOptions, TransactionStats } from './transaction';
 
+/**
+ * Callable model accessor that preserves a descriptor's inferred document type.
+ * @since v3.3.0
+ */
+export interface ModelBindingAccessor {
+    <TDocument>(descriptor: ModelDescriptor<string, TDocument>): ModelInstance<TDocument>;
+    <TDocument = any>(modelName: string): ModelInstance<TDocument>;
+}
+
 /** Write path policy mode. `allow-both` preserves the existing collection and model write behavior. */
 export type WritePathPolicyMode = 'allow-both' | 'model-only';
 
@@ -283,7 +292,7 @@ export interface MonSQLizeInstance {
         db: (name?: string) => DbAccessor;
         use: (name: string) => {
             collection: <TSchema = any>(collectionName: string) => Collection<TSchema>;
-            model: <TDocument = any>(modelName: string) => ModelInstance<TDocument>;
+            model: ModelBindingAccessor;
         };
         instance: MonSQLize;
     }>;
@@ -315,7 +324,7 @@ export interface MonSQLizeInstance {
      */
     use(name: string): {
         collection: <TSchema = any>(collectionName: string) => Collection<TSchema>;
-        model: <TDocument = any>(modelName: string) => ModelInstance<TDocument>;
+        model: ModelBindingAccessor;
     };
     /**
      * Return collection and model accessors for the named connection pool.
@@ -323,10 +332,10 @@ export interface MonSQLizeInstance {
      */
     pool(poolName: string): {
         collection: <TSchema = any>(name: string) => Collection<TSchema>;
-        model: <TDocument = any>(name: string) => ModelInstance<TDocument>;
+        model: ModelBindingAccessor;
         use: (dbName: string) => {
             collection: <TSchema = any>(name: string) => Collection<TSchema>;
-            model: <TDocument = any>(name: string) => ModelInstance<TDocument>;
+            model: ModelBindingAccessor;
         };
     };
     /**
@@ -341,12 +350,16 @@ export interface MonSQLizeInstance {
      * @param name Model name.
      * @param options Optional database or pool scope options.
      */
+    /** @since v3.3.0 */
+    scopedModel<TDocument>(descriptor: ModelDescriptor<string, TDocument>, options?: { database?: string; pool?: string; }): ModelInstance<TDocument>;
     scopedModel<TDocument = any>(name: string, options?: { database?: string; pool?: string; }): ModelInstance<TDocument>;
     scopedModel(name: string, options?: { database?: string; pool?: string; }): ModelInstance<any>;
     /**
      * Return the registered model instance for the given model name.
      * @param name Model name used during registration.
      */
+    /** @since v3.3.0 */
+    model<TDocument>(descriptor: ModelDescriptor<string, TDocument>): ModelInstance<TDocument>;
     model<TDocument = any>(name: string): ModelInstance<TDocument>;
     model(name: string): ModelInstance<any>;
     /**
@@ -516,7 +529,7 @@ export default class MonSQLize implements MonSQLizeInstance {
         db: (name?: string) => DbAccessor;
         use: (name: string) => {
             collection: <TSchema = any>(collectionName: string) => Collection<TSchema>;
-            model: <TDocument = any>(modelName: string) => ModelInstance<TDocument>;
+            model: ModelBindingAccessor;
         };
         instance: MonSQLize;
     }>;
@@ -529,20 +542,24 @@ export default class MonSQLize implements MonSQLizeInstance {
     db(name?: string): DbAccessor;
     use(name: string): {
         collection: <TSchema = any>(collectionName: string) => Collection<TSchema>;
-        model: <TDocument = any>(modelName: string) => ModelInstance<TDocument>;
+        model: ModelBindingAccessor;
     };
     pool(poolName: string): {
         collection: <TSchema = any>(name: string) => Collection<TSchema>;
-        model: <TDocument = any>(name: string) => ModelInstance<TDocument>;
+        model: ModelBindingAccessor;
         use: (dbName: string) => {
             collection: <TSchema = any>(name: string) => Collection<TSchema>;
-            model: <TDocument = any>(name: string) => ModelInstance<TDocument>;
+            model: ModelBindingAccessor;
         };
     };
     scopedCollection<TSchema = any>(name: string, options?: { database?: string; pool?: string; }): Collection<TSchema>;
     scopedCollection(name: string, options?: { database?: string; pool?: string; }): Collection<any>;
+    /** @since v3.3.0 */
+    scopedModel<TDocument>(descriptor: ModelDescriptor<string, TDocument>, options?: { database?: string; pool?: string; }): ModelInstance<TDocument>;
     scopedModel<TDocument = any>(name: string, options?: { database?: string; pool?: string; }): ModelInstance<TDocument>;
     scopedModel(name: string, options?: { database?: string; pool?: string; }): ModelInstance<any>;
+    /** @since v3.3.0 */
+    model<TDocument>(descriptor: ModelDescriptor<string, TDocument>): ModelInstance<TDocument>;
     model<TDocument = any>(name: string): ModelInstance<TDocument>;
     model(name: string): ModelInstance<any>;
     ensureModelIndexes(options?: ModelEnsureAllIndexesOptions): Promise<ModelIndexEnsureSummary>;
@@ -601,6 +618,8 @@ export default class MonSQLize implements MonSQLizeInstance {
     static LockTimeoutError: typeof import('./lock').LockTimeoutError;
     static DistributedCacheInvalidator: typeof DistributedCacheInvalidator;
     static ConnectionPoolManager: typeof import('./pool').ConnectionPoolManager;
+    /** @since v3.3.0 */
+    static defineModel: typeof import('./model').defineModel;
     static Model: typeof import('./runtime').Model;
     static ModelInstance: typeof import('./runtime').ModelInstance;
     static expr: typeof expr;

package/dist/types/runtime.d.mts

@@ -1,6 +1,6 @@
 import type { BookmarkClearResult, BookmarkListResult, BookmarkPrewarmResult, DeleteBatchResult, DeleteResult, IncrementOneResult, IndexCreateResult, InsertBatchResult, InsertManyResult, UpdateBatchResult, UpdateResult } from './collection.mjs';
 import type { LoggerLike, ExpressionFunction, ExpressionObject } from './base.mjs';
-import type { ModelDefinition, ModelEnsureIndexesOptions, ModelIndexEnsureResult, ModelInstance as ModelInstanceContract, RegisteredModel, RelationConfig } from './model.mjs';
+import type { ModelDefinition, ModelDescriptor, ModelEnsureIndexesOptions, ModelIndexEnsureResult, ModelInstance as ModelInstanceContract, RegisteredModel, RelationConfig } from './model.mjs';
 import type { LockOptions, LockStats } from './lock.mjs';
 import type { ConnectionPoolManagerOptions, FallbackStrategy, PoolConfig, PoolHealthStatus, PoolRole, PoolStats, PoolStrategy } from './pool.mjs';
 import type { SagaDefinition, SagaOrchestratorOptions, SagaResult, SagaStats, SagaStep } from './saga.mjs';
@@ -289,6 +289,8 @@ export declare class FunctionCache {
 }
 
 export declare class Model {
+    /** @since v3.3.0 */
+    static define<TName extends string, TDocument>(descriptor: ModelDescriptor<TName, TDocument>): void;
     static define<TDocument = any>(name: string, definition: ModelDefinition<TDocument>): void;
     static get<TDocument = any>(name: string): RegisteredModel<TDocument> | undefined;
     static has(name: string): boolean;
@@ -334,6 +336,7 @@ export declare class ModelInstance<TDocument = any> implements ModelInstanceCont
         meta?: import('./collection.mjs').MetaInfo;
     }>;
     findAndCount(query?: unknown, options?: unknown): import('./model.mjs').PopulateProxy<{ data: Array<import('./model.mjs').ModelDocument<TDocument>>; total: number; }>;
+    vectorSearch(options: import('./model.mjs').ModelVectorSearchOptions): Promise<Array<import('./collection.mjs').VectorSearchHit<import('./model.mjs').ModelDocument<TDocument>>>>;
     count(query?: unknown, options?: unknown): Promise<number>;
     insertOne(document?: unknown, options?: unknown): Promise<{ acknowledged: boolean; insertedId: any; }>;
     insertMany(documents?: unknown[], options?: unknown): Promise<InsertManyResult>;
@@ -345,6 +348,9 @@ export declare class ModelInstance<TDocument = any> implements ModelInstanceCont
     upsertOne(filter?: unknown, update?: unknown, options?: unknown): Promise<UpdateResult>;
     deleteOne(filter?: unknown, options?: unknown): Promise<DeleteResult>;
     deleteMany(filter?: unknown, options?: unknown): Promise<DeleteResult>;
+    checkRelationUsage(filter?: unknown, options?: import('./model.mjs').RelationUsageOptions): Promise<import('./model.mjs').RelationUsageReport>;
+    deleteOneWithRelations(filter: unknown, options?: import('./model.mjs').RelationProtectedDeleteOptions): Promise<import('./model.mjs').RelationProtectedDeleteResult>;
+    forceDeleteWithRelations(filter: unknown, options?: import('./model.mjs').RelationProtectedDeleteOptions): Promise<import('./model.mjs').RelationProtectedDeleteResult>;
     createIndex(keys: unknown, options?: unknown): Promise<IndexCreateResult>;
     createIndexes(specs: Array<{ key: unknown; } & Record<string, unknown>>): Promise<string[]>;
     listIndexes(): Promise<Record<string, unknown>[]>;

package/dist/types/runtime.d.ts

@@ -1,6 +1,6 @@
 import type { BookmarkClearResult, BookmarkListResult, BookmarkPrewarmResult, DeleteBatchResult, DeleteResult, IncrementOneResult, IndexCreateResult, InsertBatchResult, InsertManyResult, UpdateBatchResult, UpdateResult } from './collection';
 import type { LoggerLike, ExpressionFunction, ExpressionObject } from './base';
-import type { ModelDefinition, ModelEnsureIndexesOptions, ModelIndexEnsureResult, ModelInstance as ModelInstanceContract, RegisteredModel, RelationConfig } from './model';
+import type { ModelDefinition, ModelDescriptor, ModelEnsureIndexesOptions, ModelIndexEnsureResult, ModelInstance as ModelInstanceContract, RegisteredModel, RelationConfig } from './model';
 import type { LockOptions, LockStats } from './lock';
 import type { ConnectionPoolManagerOptions, FallbackStrategy, PoolConfig, PoolHealthStatus, PoolRole, PoolStats, PoolStrategy } from './pool';
 import type { SagaDefinition, SagaOrchestratorOptions, SagaResult, SagaStats, SagaStep } from './saga';
@@ -289,6 +289,8 @@ export declare class FunctionCache {
 }
 
 export declare class Model {
+    /** @since v3.3.0 */
+    static define<TName extends string, TDocument>(descriptor: ModelDescriptor<TName, TDocument>): void;
     static define<TDocument = any>(name: string, definition: ModelDefinition<TDocument>): void;
     static get<TDocument = any>(name: string): RegisteredModel<TDocument> | undefined;
     static has(name: string): boolean;
@@ -334,6 +336,7 @@ export declare class ModelInstance<TDocument = any> implements ModelInstanceCont
         meta?: import('./collection').MetaInfo;
     }>;
     findAndCount(query?: unknown, options?: unknown): import('./model').PopulateProxy<{ data: Array<import('./model').ModelDocument<TDocument>>; total: number; }>;
+    vectorSearch(options: import('./model').ModelVectorSearchOptions): Promise<Array<import('./collection').VectorSearchHit<import('./model').ModelDocument<TDocument>>>>;
     count(query?: unknown, options?: unknown): Promise<number>;
     insertOne(document?: unknown, options?: unknown): Promise<{ acknowledged: boolean; insertedId: any; }>;
     insertMany(documents?: unknown[], options?: unknown): Promise<InsertManyResult>;
@@ -345,6 +348,9 @@ export declare class ModelInstance<TDocument = any> implements ModelInstanceCont
     upsertOne(filter?: unknown, update?: unknown, options?: unknown): Promise<UpdateResult>;
     deleteOne(filter?: unknown, options?: unknown): Promise<DeleteResult>;
     deleteMany(filter?: unknown, options?: unknown): Promise<DeleteResult>;
+    checkRelationUsage(filter?: unknown, options?: import('./model').RelationUsageOptions): Promise<import('./model').RelationUsageReport>;
+    deleteOneWithRelations(filter: unknown, options?: import('./model').RelationProtectedDeleteOptions): Promise<import('./model').RelationProtectedDeleteResult>;
+    forceDeleteWithRelations(filter: unknown, options?: import('./model').RelationProtectedDeleteOptions): Promise<import('./model').RelationProtectedDeleteResult>;
     createIndex(keys: unknown, options?: unknown): Promise<IndexCreateResult>;
     createIndexes(specs: Array<{ key: unknown; } & Record<string, unknown>>): Promise<string[]>;
     listIndexes(): Promise<Record<string, unknown>[]>;

package/licenses/production-dependencies.json

@@ -5,7 +5,7 @@
     { "name": "cache-hub", "version": "2.2.4", "license": "Apache-2.0", "source": "package-metadata" },
     { "name": "ioredis", "version": "5.11.1", "license": "MIT", "source": "package-metadata" },
     { "name": "mongodb", "version": "6.21.0", "license": "Apache-2.0", "source": "package-metadata" },
-    { "name": "schema-dsl", "version": "3.0.0", "license": "Apache-2.0", "source": "package-metadata" },
+    { "name": "schema-dsl", "version": "3.0.4", "license": "Apache-2.0", "source": "package-metadata" },
     { "name": "ssh2", "version": "1.17.0", "license": "MIT", "source": "LICENSE:d06b5d27bbbbe22c36b1fd88406b1208876e2d37d795f5b8eaed951a459a3111" }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monsqlize",
-    "version": "3.1.14",
+    "version": "3.3.0",
     "description": "TypeScript production data runtime layer for MongoDB today, with cache, transactions, pools, models, sync, and observability",
     "type": "commonjs",
     "main": "./dist/cjs/index.cjs",
@@ -21,6 +21,8 @@
         "./package.json": "./package.json"
     },
     "files": [
+        "changelogs/v3.3.0.md",
+        "changelogs/v3.2.0.md",
         "changelogs/v3.1.14.md",
         "changelogs/v3.1.13.md",
         "changelogs/v3.1.12.md",
@@ -159,7 +161,16 @@
         "cache-hub": "2.2.4",
         "ioredis": "5.11.1",
         "mongodb": "6.21.0",
-        "schema-dsl": "3.0.0",
+        "schema-dsl": "3.0.4",
         "ssh2": "1.17.0"
+    },
+    "overrides": {
+        "fast-uri": "3.1.5",
+        "minimatch@3.1.5": {
+            "brace-expansion": "1.1.18"
+        },
+        "minimatch@10.2.5": {
+            "brace-expansion": "5.0.9"
+        }
     }
 }