@opra/mongodb 0.32.5 → 0.33.0

package/types/mongo-collection-service.d.ts

@@ -1,6 +1,6 @@
 import mongodb from 'mongodb';
 import { StrictOmit, Type } from 'ts-gems';
-import { DTO, PartialDTO, PatchDTO } from '@opra/common';
+import { PartialDTO, PatchDTO } from '@opra/common';
 import * as OpraCommon from '@opra/common';
 import { FilterInput } from './adapter-utils/prepare-filter.js';
 import { MongoService } from './mongo-service.js';
@@ -27,7 +27,13 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      *
      * @type {FilterInput | Function}
      */
-    $documentFilter?: FilterInput | ((_this: this) => FilterInput | Promise<FilterInput> | undefined);
+    $documentFilter?: FilterInput | ((args: {
+        crud: MongoService.CrudOp;
+        method: string;
+        documentId?: AnyId;
+        input?: Record<string, any>;
+        options?: Record<string, any>;
+    }, _this: this) => FilterInput | Promise<FilterInput> | undefined);
     /**
      * Interceptor function for handling callback execution with provided arguments.
      *
@@ -41,11 +47,11 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @param {Object} _this - The reference to the current object.
      * @returns {Promise<any>} - The promise that resolves to the result of the callback execution.
      */
-    $interceptor?: (callback: (...args: any[]) => any, args: {
+    $interceptor?: (callback: () => any, args: {
         crud: MongoService.CrudOp;
         method: string;
         documentId?: AnyId;
-        input?: Object;
+        input?: Record<string, any>;
         options?: Record<string, any>;
     }, _this: any) => Promise<any>;
     /**
@@ -63,7 +69,7 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @param {AnyId} id - The ID of the resource to assert.
      * @param {MongoCollectionService.ExistsOptions} [options] - Optional options for checking the existence.
      * @returns {Promise<void>} - A Promise that resolves when the resource exists.
-     * @throws {ResourceNotFoundError} - If the resource does not exist.
+     * @throws {ResourceNotAvailableError} - If the resource does not exist.
      */
     assert(id: AnyId, options?: MongoCollectionService.ExistsOptions): Promise<void>;
     /**
@@ -74,7 +80,8 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @returns {Promise<PartialDTO<T>>} A promise that resolves to the created document.
      * @throws {Error} if an unknown error occurs while creating the document.
      */
-    create(input: DTO<T>, options?: MongoCollectionService.CreateOptions): Promise<PartialDTO<T>>;
+    create(input: PartialDTO<T>, options?: MongoCollectionService.CreateOptions): Promise<PartialDTO<T>>;
+    protected _create(input: PartialDTO<T>, options: MongoCollectionService.CreateOptions | undefined): Promise<PartialDTO<T>>;
     /**
      * Returns the count of documents in the collection based on the provided options.
      *
@@ -82,6 +89,7 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @return {Promise<number>} - A promise that resolves to the count of documents in the collection.
      */
     count(options?: MongoCollectionService.CountOptions<T>): Promise<number>;
+    protected _count(options?: MongoCollectionService.CountOptions<T>): Promise<number>;
     /**
      * Deletes a document from the collection.
      *
@@ -90,6 +98,7 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @return {Promise<number>} - A Promise that resolves to the number of documents deleted.
      */
     delete(id: AnyId, options?: MongoCollectionService.DeleteOptions<T>): Promise<number>;
+    protected _delete(id: AnyId, options?: MongoCollectionService.DeleteOptions<T>): Promise<number>;
     /**
      * Deletes multiple documents from the collection that meet the specified filter criteria.
      *
@@ -97,14 +106,22 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @return {Promise<number>} - A promise that resolves to the number of documents deleted.
      */
     deleteMany(options?: MongoCollectionService.DeleteManyOptions<T>): Promise<number>;
+    protected _deleteMany(options?: MongoCollectionService.DeleteManyOptions<T>): Promise<number>;
     /**
      * Checks if an object with the given id exists.
      *
      * @param {AnyId} id - The id of the object to check.
-     * @param {MongoCollectionService.ExistsOptions} [options] - The options for the aggregation query (optional).
+     * @param {MongoCollectionService.ExistsOptions} [options] - The options for the query (optional).
      * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the object exists or not.
      */
     exists(id: AnyId, options?: MongoCollectionService.ExistsOptions): Promise<boolean>;
+    /**
+     * Checks if an object with the given arguments exists.
+     *
+     * @param {MongoCollectionService.ExistsOneOptions} [options] - The options for the query (optional).
+     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the object exists or not.
+     */
+    existsOne(options?: MongoCollectionService.ExistsOneOptions<T>): Promise<boolean>;
     /**
      * Finds a document by its ID.
      *
@@ -113,6 +130,7 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @return {Promise<PartialDTO<T | undefined>>} - A promise resolving to the found document, or undefined if not found.
      */
     findById(id: AnyId, options?: MongoCollectionService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
+    protected _findById(id: AnyId, options?: MongoCollectionService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
     /**
      * Finds a document in the collection that matches the specified options.
      *
@@ -120,6 +138,7 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @return {Promise<PartialDTO<T> | undefined>} A promise that resolves with the found document or undefined if no document is found.
      */
     findOne(options?: MongoCollectionService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
+    protected _findOne(options?: MongoCollectionService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
     /**
      * Finds multiple documents in the MongoDB collection.
      *
@@ -136,6 +155,7 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @return A Promise that resolves to an array of partial outputs of type T.
      */
     findMany(options?: MongoCollectionService.FindManyOptions<T>): Promise<PartialDTO<T>[]>;
+    protected _findMany(options?: MongoCollectionService.FindManyOptions<T>): Promise<PartialDTO<T>[]>;
     /**
      * Retrieves a document from the collection by its ID. Throws error if not found.
      *
@@ -143,7 +163,7 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @param {MongoCollectionService.FindOneOptions} [options] - Optional options for the findOne operation.
      * @returns {Promise<PartialDTO<T>>} - A promise that resolves to the retrieved document,
      *    or rejects with a ResourceNotFoundError if the document does not exist.
-     * @throws {ResourceNotFoundError} - If the document with the specified ID does not exist.
+     * @throws {ResourceNotAvailableError} - If the document with the specified ID does not exist.
      */
     get(id: AnyId, options?: MongoCollectionService.FindOneOptions): Promise<PartialDTO<T>>;
     /**
@@ -156,6 +176,7 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * undefined if the document was not found.
      */
     update(id: AnyId, input: PatchDTO<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<PartialDTO<T> | undefined>;
+    protected _update(id: AnyId, input: PatchDTO<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<PartialDTO<T> | undefined>;
     /**
      * Updates a document in the collection with the specified ID.
      *
@@ -165,6 +186,7 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
      */
     updateOnly(id: AnyId, input: PatchDTO<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<number>;
+    protected _updateOnly(id: AnyId, input: PatchDTO<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<number>;
     /**
      * Updates multiple documents in the collection based on the specified input and options.
      *
@@ -173,6 +195,7 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @return {Promise<number>} - A promise that resolves to the number of documents matched and modified.
      */
     updateMany(input: PatchDTO<T>, options?: MongoCollectionService.UpdateManyOptions<T>): Promise<number>;
+    protected _updateMany(input: PatchDTO<T>, options?: MongoCollectionService.UpdateManyOptions<T>): Promise<number>;
     /**
      * Generates an ID.
      *
@@ -188,7 +211,20 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @returns {FilterInput | Promise<FilterInput> | undefined} The common filter or a Promise
      * that resolves to the common filter, or undefined if not available.
      */
-    protected _getDocumentFilter(): FilterInput | Promise<FilterInput> | undefined;
+    protected _getDocumentFilter(args: {
+        crud: MongoService.CrudOp;
+        method: string;
+        documentId?: AnyId;
+        input?: Object;
+        options?: Record<string, any>;
+    }): FilterInput | Promise<FilterInput> | undefined;
+    protected _intercept(callback: (...args: any[]) => any, args: {
+        crud: MongoService.CrudOp;
+        method: string;
+        documentId?: AnyId;
+        input?: Object;
+        options?: Record<string, any>;
+    }): Promise<any>;
 }
 /**
  *
@@ -296,4 +332,19 @@ export declare namespace MongoCollectionService {
      */
     interface ExistsOptions extends Omit<mongodb.CommandOperationOptions, 'writeConcern'> {
     }
+    /**
+     * Represents options for checking the document exists
+     *
+     * @interface
+     */
+    interface ExistsOneOptions<T> extends Omit<mongodb.CommandOperationOptions, 'writeConcern'> {
+        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
+    }
+    interface OperationInfo {
+        crud: MongoService.CrudOp;
+        method: string;
+        documentId?: AnyId;
+        input?: Record<string, any>;
+        options?: Record<string, any>;
+    }
 }

package/types/mongo-service.d.ts

@@ -1,17 +1,17 @@
-import mongodb from 'mongodb';
+import mongodb, { TransactionOptions } from 'mongodb';
 import { StrictOmit, Type } from 'ts-gems';
-import vg from 'valgen';
+import { IsObject } from 'valgen';
 import { ComplexType, PartialDTO } from '@opra/common';
-import { ApiService, RequestContext } from '@opra/core';
-import { AnyId } from './types.js';
+import { ApiService } from '@opra/core';
+import { AnyId, WithTransactionCallback } from './types.js';
 /**
  * Class representing a MongoDB service for interacting with a collection.
  * @extends ApiService
  * @template T - The type of the documents in the collection.
  */
 export declare class MongoService<T extends mongodb.Document> extends ApiService {
-    protected _encoders: Record<string, vg.ObjectValidator<T>>;
-    protected _decoder?: vg.ObjectValidator<T>;
+    protected _encoders: Record<string, IsObject.Validator<T>>;
+    protected _decoder?: IsObject.Validator<T>;
     protected _dataType: Type | string;
     /**
      * Represents the name of a collection in MongoDB
@@ -70,15 +70,23 @@ export declare class MongoService<T extends mongodb.Document> extends ApiService
      * Retrieves the encoder for the specified operation.
      *
      * @param {String} operation - The operation to retrieve the encoder for. Valid values are 'create' and 'update'.
-     * @returns {vg.ObjectValidator<T>} - The encoder for the specified operation.
+     * @returns {IsObject.Validator<T>} - The encoder for the specified operation.
      */
-    getEncoder(operation: 'create' | 'update'): vg.ObjectValidator<T>;
+    getEncoder(operation: 'create' | 'update'): IsObject.Validator<T>;
     /**
      * Retrieves the decoder.
      *
-     * @returns {vg.ObjectValidator<T>} - The encoder for the specified operation.
+     * @returns {IsObject.Validator<T>} - The encoder for the specified operation.
      */
-    getDecoder(): vg.ObjectValidator<T>;
+    getDecoder(): IsObject.Validator<T>;
+    /**
+     * Executes the provided function within a transaction.
+     *
+     * @param {WithTransactionCallback} callback - The function to be executed within the transaction.
+     * @param {TransactionOptions} [options] - Optional options for the transaction.
+     * @returns {Promise<any>} - A promise that resolves with the result of the function execution within the transaction.
+     */
+    withTransaction(callback: WithTransactionCallback, options?: TransactionOptions): Promise<any>;
     /**
      * Inserts a single document into MongoDB. If documents passed in do not contain the **_id** field,
      * one will be added to each of the documents missing it by the driver, mutating the document. This behavior
@@ -217,32 +225,21 @@ export declare class MongoService<T extends mongodb.Document> extends ApiService
      * @throws {Error} If the collection name is not defined.
      */
     getResourceName(): string;
-    /**
-     * Compares the current instance with the provided attributes and returns true if they match, false otherwise.
-     * This method is protected and should only be called by subclasses.
-     *
-     * @param {MongoService<any>} service - The service instance to compare.
-     * @param {RequestContext} context - The request context.
-     * @param {Object} attributes - Optional attributes object for comparison.
-     * @return {boolean} - True if the instance matches the provided attributes, false otherwise.
-     * @protected
-     */
-    protected _instanceCompare(service: MongoService<any>, context: RequestContext, attributes?: any): boolean;
     /**
      * Generates an encoder for the specified operation.
      *
      * @param {string} operation - The operation to generate the encoder for. Must be either 'create' or 'update'.
      * @protected
-     * @returns {vg.Validator} - The generated encoder for the specified operation.
+     * @returns {IsObject.Validator} - The generated encoder for the specified operation.
      */
-    protected _generateEncoder(operation: 'create' | 'update'): vg.ObjectValidator<T>;
+    protected _generateEncoder(operation: 'create' | 'update'): IsObject.Validator<T>;
     /**
      * Generates an encoder for the specified operation.
      *
      * @protected
-     * @returns {vg.Validator} - The generated encoder for the specified operation.
+     * @returns {IsObject.Validator} - The generated encoder for the specified operation.
      */
-    protected _generateDecoder(): vg.ObjectValidator<T>;
+    protected _generateDecoder(): IsObject.Validator<T>;
 }
 /**
  * The namespace for the MongoService.

package/types/mongo-singleton-service.d.ts

@@ -1,6 +1,6 @@
 import mongodb from 'mongodb';
 import { StrictOmit, Type } from 'ts-gems';
-import { DTO, PartialDTO, PatchDTO } from '@opra/common';
+import { PartialDTO, PatchDTO } from '@opra/common';
 import * as OpraCommon from '@opra/common';
 import { FilterInput } from './adapter-utils/prepare-filter.js';
 import { MongoService } from './mongo-service.js';
@@ -28,7 +28,13 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
      *
      * @type {FilterInput | Function}
      */
-    $documentFilter?: FilterInput | ((_this: this) => FilterInput | Promise<FilterInput> | undefined);
+    $documentFilter?: FilterInput | ((args: {
+        crud: MongoService.CrudOp;
+        method: string;
+        documentId?: AnyId;
+        input?: Record<string, any>;
+        options?: Record<string, any>;
+    }, _this: this) => FilterInput | Promise<FilterInput> | undefined);
     /**
      * Interceptor function for handling callback execution with provided arguments.
      *
@@ -46,7 +52,7 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
         crud: MongoService.CrudOp;
         method: string;
         documentId?: AnyId;
-        input?: Object;
+        input?: Record<string, any>;
         options?: Record<string, any>;
     }, _this: any) => Promise<any>;
     /**
@@ -61,7 +67,7 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
      * Asserts the existence of a resource based on the given options.
      *
      * @returns {Promise<void>} A Promise that resolves when the resource exists.
-     * @throws {ResourceNotFoundError} If the resource does not exist.
+     * @throws {ResourceNotAvailableError} If the resource does not exist.
      */
     assert(options?: MongoSingletonService.ExistsOptions): Promise<void>;
     /**
@@ -72,7 +78,8 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
      * @return {Promise<PartialDTO<T>>} A promise that resolves to the partial output of the created document.
      * @throws {Error} Throws an error if an unknown error occurs while creating the document.
      */
-    create(input: DTO<T>, options?: MongoSingletonService.CreateOptions): Promise<PartialDTO<T>>;
+    create(input: PartialDTO<T>, options?: MongoSingletonService.CreateOptions): Promise<PartialDTO<T>>;
+    protected _create(input: PartialDTO<T>, options?: MongoSingletonService.CreateOptions): Promise<PartialDTO<T>>;
     /**
      * Deletes a record from the database
      *
@@ -80,6 +87,7 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
      * @returns {Promise<number>} The number of records deleted
      */
     delete(options?: MongoSingletonService.DeleteOptions<T>): Promise<number>;
+    protected _delete(options?: MongoSingletonService.DeleteOptions<T>): Promise<number>;
     /**
      * Checks if the document exists in the database.
      *
@@ -93,12 +101,13 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
      * @returns {Promise<PartialDTO<T> | undefined>} - A promise that resolves to the found document or undefined if not found.
      */
     findOne(options?: MongoSingletonService.FindOptions<T>): Promise<PartialDTO<T> | undefined>;
+    protected _findOne(options?: MongoSingletonService.FindOptions<T>): Promise<PartialDTO<T> | undefined>;
     /**
      * Fetches the document from the Mongo collection service. Throws error if not found.
      *
      * @param {MongoCollectionService.FindOneOptions} options - The options to customize the query.
      * @return {Promise<PartialDTO<T>>} - A promise that resolves to the fetched document.
-     * @throws {ResourceNotFoundError} - If the document is not found in the collection.
+     * @throws {ResourceNotAvailableError} - If the document is not found in the collection.
      */
     get(options?: MongoSingletonService.FindOptions<T>): Promise<PartialDTO<T>>;
     /**
@@ -110,6 +119,7 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
      * @return {Promise<number>} - A promise that resolves to the updated document or undefined if not found.
      */
     updateOnly(input: PatchDTO<T>, options?: MongoSingletonService.UpdateOptions<T>): Promise<number>;
+    protected _updateOnly(input: PatchDTO<T>, options?: MongoSingletonService.UpdateOptions<T>): Promise<number>;
     /**
      * Updates a document in the MongoDB collection.
      *
@@ -119,6 +129,7 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
      * @return {Promise<PartialDTO<T> | undefined>} - A promise that resolves to the updated document or undefined if not found.
      */
     update(input: PatchDTO<T>, options?: MongoSingletonService.UpdateOptions<T>): Promise<PartialDTO<T> | undefined>;
+    protected _update(input: PatchDTO<T>, options?: MongoSingletonService.UpdateOptions<T>): Promise<PartialDTO<T> | undefined>;
     /**
      * Retrieves the common filter used for querying the document.
      * This method is mostly used for security issues like securing multi-tenant applications.
@@ -127,7 +138,20 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
      * @returns {FilterInput | Promise<FilterInput> | undefined} The common filter or a Promise
      * that resolves to the common filter, or undefined if not available.
      */
-    protected _getDocumentFilter(): FilterInput | Promise<FilterInput> | undefined;
+    protected _getDocumentFilter(args: {
+        crud: MongoService.CrudOp;
+        method: string;
+        documentId?: AnyId;
+        input?: Object;
+        options?: Record<string, any>;
+    }): FilterInput | Promise<FilterInput> | undefined;
+    protected _intercept(callback: (...args: any[]) => any, args: {
+        crud: MongoService.CrudOp;
+        method: string;
+        documentId?: AnyId;
+        input?: Object;
+        options?: Record<string, any>;
+    }): Promise<any>;
 }
 /**
  *

package/types/types.d.ts

@@ -1,2 +1,3 @@
-import { ObjectId } from 'mongodb';
+import { ClientSession, ObjectId } from 'mongodb';
 export type AnyId = string | number | ObjectId;
+export type WithTransactionCallback = (session: ClientSession) => any;