@opra/mongodb 0.33.13 → 1.0.0-alpha.10

package/types/mongo-service.d.ts

@@ -1,27 +1,156 @@
-import mongodb, { TransactionOptions } from 'mongodb';
-import { StrictOmit, Type } from 'ts-gems';
+import * as OpraCommon from '@opra/common';
+import { ComplexType } from '@opra/common';
+import { ServiceBase } from '@opra/core';
+import mongodb, { Document, TransactionOptions } from 'mongodb';
+import { PartialDTO, StrictOmit, Type } from 'ts-gems';
 import { IsObject } from 'valgen';
-import { ComplexType, PartialDTO } from '@opra/common';
-import { ApiService } from '@opra/core';
-import { AnyId, WithTransactionCallback } from './types.js';
+import { MongoAdapter } from './mongo-adapter.js';
+/**
+ * The namespace for the MongoService.
+ *
+ * @namespace MongoService
+ */
+export declare namespace MongoService {
+    interface Options {
+        db?: MongoService<any>['db'];
+        session?: MongoService<any>['session'];
+        collectionName?: MongoService<any>['$collectionName'];
+        resourceName?: MongoService<any>['$resourceName'];
+        documentFilter?: MongoService<any>['$documentFilter'];
+        interceptor?: MongoService<any>['$interceptor'];
+        idGenerator?: MongoService<any>['$idGenerator'];
+        onError?: MongoService<any>['$onError'];
+    }
+    type CrudOp = 'create' | 'read' | 'update' | 'delete';
+    interface CommandInfo {
+        crud: CrudOp;
+        method: string;
+        byId: boolean;
+        documentId?: MongoAdapter.AnyId;
+        nestedId?: MongoAdapter.AnyId;
+        input?: Record<string, any>;
+        options?: Record<string, any>;
+    }
+    /**
+     * Represents options for "create" operation
+     *
+     * @interface
+     */
+    interface CreateOptions extends mongodb.InsertOneOptions {
+        projection?: string[];
+    }
+    /**
+     * Represents options for "count" operation
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
+    interface CountOptions<T> extends mongodb.CountOptions {
+        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
+    }
+    /**
+     * Represents options for "delete" operation
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
+    interface DeleteOptions<T> extends mongodb.DeleteOptions {
+        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
+    }
+    /**
+     * Represents options for "deleteMany" operation
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
+    interface DeleteManyOptions<T> extends mongodb.DeleteOptions {
+        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
+    }
+    /**
+     * Represents options for "distinct" operation
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
+    interface DistinctOptions<T> extends mongodb.DistinctOptions {
+        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
+    }
+    /**
+     * Represents options for "exists" operation
+     *
+     * @interface
+     */
+    interface ExistsOptions<T> extends Omit<mongodb.CommandOperationOptions, 'writeConcern'> {
+        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
+    }
+    /**
+     * Represents options for checking the document exists
+     *
+     * @interface
+     */
+    interface ExistsOneOptions<T> extends Omit<mongodb.CommandOperationOptions, 'writeConcern'> {
+        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
+    }
+    /**
+     * Represents options for "findOne" operation
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
+    interface FindOneOptions<T> extends StrictOmit<FindManyOptions<T>, 'limit'> {
+    }
+    /**
+     * Represents options for "findMany" operation
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
+    interface FindManyOptions<T> extends mongodb.AggregateOptions {
+        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
+        projection?: string | string[] | Document;
+        sort?: string[];
+        limit?: number;
+        skip?: number;
+    }
+    /**
+     * Represents options for "update" operation
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
+    interface UpdateOptions<T> extends StrictOmit<mongodb.FindOneAndUpdateOptions, 'projection' | 'returnDocument' | 'includeResultMetadata'> {
+        projection?: string | string[] | Document;
+        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
+    }
+    /**
+     * Represents options for "updateMany" operation
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
+    interface UpdateManyOptions<T> extends StrictOmit<mongodb.UpdateOptions, 'upsert'> {
+        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
+    }
+}
 /**
  * Class representing a MongoDB service for interacting with a collection.
- * @extends ApiService
+ * @extends ServiceBase
  * @template T - The type of the documents in the collection.
  */
-export declare class MongoService<T extends mongodb.Document> extends ApiService {
-    protected _encoders: Record<string, IsObject.Validator<T>>;
-    protected _decoder?: IsObject.Validator<T>;
-    protected _dataType: Type | string;
+export declare class MongoService<T extends mongodb.Document = mongodb.Document> extends ServiceBase {
+    protected _dataType_: Type | string;
+    protected _dataType: ComplexType;
+    protected _inputCodecs: Record<string, IsObject.Validator<T>>;
+    protected _outputCodecs: Record<string, IsObject.Validator<T>>;
     /**
      * Represents the name of a collection in MongoDB
      */
-    collectionName?: string | ((_this: any) => string);
+    $collectionName?: string | ((_this: any) => string);
     /**
      * Represents the name of a resource.
      * @type {string}
      */
-    resourceName?: string | ((_this: any) => string);
+    $resourceName?: string | ((_this: any) => string);
     /**
      * Represents a MongoDB database object.
      */
@@ -33,9 +162,8 @@ export declare class MongoService<T extends mongodb.Document> extends ApiService
     /**
      * Generates a new id for new inserting Document.
      *
-     * @protected
      */
-    $idGenerator?: (_this: any) => AnyId;
+    $idGenerator?: (_this: any) => MongoAdapter.AnyId;
     /**
      * Callback function for handling errors.
      *
@@ -43,47 +171,68 @@ export declare class MongoService<T extends mongodb.Document> extends ApiService
      * @param _this - The context object.
      */
     $onError?: (error: unknown, _this: any) => void | Promise<void>;
+    /**
+     * Represents a common filter function for a MongoService.
+     *
+     * @type {FilterInput | Function}
+     */
+    $documentFilter?: MongoAdapter.FilterInput | ((args: MongoService.CommandInfo, _this: this) => MongoAdapter.FilterInput | Promise<MongoAdapter.FilterInput> | undefined);
+    /**
+     * Interceptor function for handling callback execution with provided arguments.
+     *
+     * @param callback - The callback function to be intercepted.
+     * @param {MongoService.CommandInfo} info - The arguments object containing the following properties:
+     * @param _this - The reference to the current object.
+     * @returns - The promise that resolves to the result of the callback execution.
+     */
+    $interceptor?: (callback: () => any, info: MongoService.CommandInfo, _this: any) => Promise<any>;
     /**
      * Constructs a new instance
      *
-     * @param dataType - The data type of the array elements.
-     * @param [options] - The options for the array service.
+     * @param dataType - The data type of the returning results
+     * @param [options] - The options for the service
      * @constructor
      */
     constructor(dataType: Type | string, options?: MongoService.Options);
     /**
-     * Retrieves the data type of the document
+     * Retrieves the collection name.
+     *
+     * @protected
+     * @returns The collection name.
+     * @throws {Error} If the collection name is not defined.
+     */
+    getCollectionName(): string;
+    /**
+     * Retrieves the resource name.
+     *
+     * @protected
+     * @returns {string} The resource name.
+     * @throws {Error} If the resource name is not defined.
+     */
+    getResourceName(): string;
+    /**
+     * Retrieves the OPRA data type
      *
      * @throws {NotAcceptableError} If the data type is not a ComplexType.
      */
-    getDataType(): ComplexType;
+    get dataType(): ComplexType;
     /**
-     * Retrieves the encoder for the specified operation.
+     * Retrieves the codec for the specified operation.
      *
      * @param operation - The operation to retrieve the encoder for. Valid values are 'create' and 'update'.
      */
-    getEncoder(operation: 'create' | 'update'): IsObject.Validator<T>;
+    getInputCodec(operation: string): IsObject.Validator<T>;
     /**
-     * Retrieves the decoder.
+     * Retrieves the codec.
      */
-    getDecoder(): IsObject.Validator<T>;
+    getOutputCodec(operation: string): IsObject.Validator<T>;
     /**
      * Executes the provided function within a transaction.
      *
      * @param callback - The function to be executed within the transaction.
      * @param [options] - Optional options for 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
-     * can be overridden by setting the **forceServerObjectId** flag.
-     *
-     * @param doc - The document to insert
-     * @param options - Optional settings for the command
-     * @protected
-     */
-    protected __insertOne(doc: mongodb.OptionalUnlessRequiredId<T>, options?: mongodb.InsertOneOptions): Promise<mongodb.InsertOneResult<T>>;
+    withTransaction(callback: MongoAdapter.WithTransactionCallback, options?: TransactionOptions): Promise<any>;
     /**
      * Gets the number of documents matching the filter.
      *
@@ -91,84 +240,92 @@ export declare class MongoService<T extends mongodb.Document> extends ApiService
      * @param options - The options for counting documents.
      * @protected
      */
-    protected __countDocuments(filter?: mongodb.Filter<T>, options?: mongodb.CountOptions): Promise<number>;
+    protected _dbCountDocuments(filter?: mongodb.Filter<T>, options?: mongodb.CountOptions): Promise<number>;
     /**
-     * Delete a document from a collection
+     * Acquires a connection and performs Collection.deleteOne operation
      *
      * @param filter - The filter used to select the document to remove
      * @param options - Optional settings for the command
      * @protected
      */
-    protected __deleteOne(filter?: mongodb.Filter<T>, options?: mongodb.DeleteOptions): Promise<mongodb.DeleteResult>;
+    protected _dbDeleteOne(filter?: mongodb.Filter<T>, options?: mongodb.DeleteOptions): Promise<mongodb.DeleteResult>;
     /**
-     * Delete multiple documents from a collection
+     * Acquires a connection and performs Collection.deleteMany operation
      *
      * @param filter - The filter used to select the documents to remove
      * @param options - Optional settings for the command
      * @protected
      */
-    protected __deleteMany(filter?: mongodb.Filter<T>, options?: mongodb.DeleteOptions): Promise<mongodb.DeleteResult>;
+    protected _dbDeleteMany(filter?: mongodb.Filter<T>, options?: mongodb.DeleteOptions): Promise<mongodb.DeleteResult>;
     /**
-     * Gets the number of documents matching the filter.
+     * Acquires a connection and performs Collection.distinct operation
      *
      * @param field - Field of the document to find distinct values for
      * @param filter - The filter for filtering the set of documents to which we apply the distinct filter.
      * @param options - Optional settings for the command
      * @protected
      */
-    protected __distinct(field: string, filter?: mongodb.Filter<T>, options?: mongodb.DistinctOptions): Promise<any[]>;
+    protected _dbDistinct(field: string, filter?: mongodb.Filter<T>, options?: mongodb.DistinctOptions): Promise<any[]>;
     /**
-     * Execute an aggregation framework pipeline against the collection, needs MongoDB \>= 2.2
+     * Acquires a connection and performs Collection.aggregate operation
      *
      * @param pipeline - An array of aggregation pipelines to execute
      * @param options - Optional settings for the command
      * @protected
      */
-    protected __aggregate(pipeline?: mongodb.Document[], options?: mongodb.AggregateOptions): Promise<mongodb.AggregationCursor<T>>;
+    protected _dbAggregate(pipeline?: mongodb.Document[], options?: mongodb.AggregateOptions): Promise<mongodb.AggregationCursor<T>>;
     /**
-     * Fetches the first document that matches the filter
+     * Acquires a connection and performs Collection.findOne operation
      *
      * @param filter - Query for find Operation
      * @param options - Optional settings for the command
      * @protected
      */
-    protected __findOne(filter: mongodb.Filter<T>, options?: mongodb.FindOptions): Promise<PartialDTO<T> | undefined>;
+    protected _dbFindOne(filter: mongodb.Filter<T>, options?: mongodb.FindOptions): Promise<PartialDTO<T> | undefined>;
     /**
-     * Creates a cursor for a filter that can be used to iterate over results from MongoDB
+     * Acquires a connection and performs Collection.find operation
      *
      * @param filter - The filter predicate. If unspecified,
      * then all documents in the collection will match the predicate
      * @param options - Optional settings for the command
      * @protected
      */
-    protected __find(filter: mongodb.Filter<T>, options?: mongodb.FindOptions): Promise<mongodb.FindCursor<T>>;
+    protected _dbFind(filter: mongodb.Filter<T>, options?: mongodb.FindOptions): Promise<mongodb.FindCursor<T>>;
+    /**
+     * Acquires a connection and performs Collection.insertOne operation
+     *
+     * @param doc - The document to insert
+     * @param options - Optional settings for the command
+     * @protected
+     */
+    protected _dbInsertOne(doc: mongodb.OptionalUnlessRequiredId<T>, options?: mongodb.InsertOneOptions): Promise<mongodb.InsertOneResult<T>>;
     /**
-     * Update a single document in a collection
+     * Acquires a connection and performs Collection.updateOne operation
      *
      * @param filter - The filter used to select the document to update
      * @param update - The update operations to be applied to the document
      * @param options - Optional settings for the command
      * @protected
      */
-    protected __updateOne(filter: mongodb.Filter<T>, update: mongodb.UpdateFilter<T>, options?: mongodb.UpdateOptions): Promise<mongodb.UpdateResult<T>>;
+    protected _dbUpdateOne(filter: mongodb.Filter<T>, update: mongodb.UpdateFilter<T>, options?: mongodb.UpdateOptions): Promise<mongodb.UpdateResult<T>>;
     /**
-     * Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation.
+     * Acquires a connection and performs Collection.findOneAndUpdate operation
      *
      * @param filter - The filter used to select the document to update
      * @param update - Update operations to be performed on the document
      * @param options - Optional settings for the command
      * @protected
      */
-    protected __findOneAndUpdate(filter: mongodb.Filter<T>, update: mongodb.UpdateFilter<T>, options?: mongodb.FindOneAndUpdateOptions): Promise<mongodb.WithId<T> | null>;
+    protected _dbFindOneAndUpdate(filter: mongodb.Filter<T>, update: mongodb.UpdateFilter<T>, options?: mongodb.FindOneAndUpdateOptions): Promise<mongodb.WithId<T> | null>;
     /**
-     * Update multiple documents in a collection
+     * Acquires a connection and performs Collection.updateMany operation
      *
      * @param filter - The filter used to select the documents to update
      * @param update - The update operations to be applied to the documents
      * @param options - Optional settings for the command
      * @protected
      */
-    protected __updateMany(filter: mongodb.Filter<T>, update: mongodb.UpdateFilter<T> | Partial<T>, options?: StrictOmit<mongodb.UpdateOptions, 'upsert'>): Promise<mongodb.UpdateResult<T>>;
+    protected _dbUpdateMany(filter: mongodb.Filter<T>, update: mongodb.UpdateFilter<T> | Partial<T>, options?: StrictOmit<mongodb.UpdateOptions, 'upsert'>): Promise<mongodb.UpdateResult<T>>;
     /**
      * Retrieves the database connection.
      *
@@ -193,50 +350,20 @@ export declare class MongoService<T extends mongodb.Document> extends ApiService
      */
     protected getCollection(db: mongodb.Db): Promise<mongodb.Collection<T>>;
     /**
-     * Retrieves the collection name.
-     *
-     * @protected
-     * @returns The collection name.
-     * @throws {Error} If the collection name is not defined.
-     */
-    getCollectionName(): string;
-    /**
-     * Retrieves the resource name.
+     * Generates an ID.
      *
      * @protected
-     * @returns {string} The resource name.
-     * @throws {Error} If the collection name is not defined.
+     * @returns {MongoAdapter.AnyId} The generated ID.
      */
-    getResourceName(): string;
+    protected _generateId(): MongoAdapter.AnyId;
     /**
-     * Generates an encoder for the specified operation.
+     * Retrieves the common filter used for querying documents.
+     * This method is mostly used for security issues like securing multi-tenant applications.
      *
-     * @param operation - The operation to generate the encoder for. Must be either 'create' or 'update'.
      * @protected
-     * @returns - The generated encoder for the specified operation.
+     * @returns {FilterInput | Promise<FilterInput> | undefined} The common filter or a Promise
+     * that resolves to the common filter, or undefined if not available.
      */
-    protected _generateEncoder(operation: 'create' | 'update'): IsObject.Validator<T>;
-    /**
-     * Generates an encoder for the specified operation.
-     *
-     * @protected
-     * @returns - The generated encoder for the specified operation.
-     */
-    protected _generateDecoder(): IsObject.Validator<T>;
-}
-/**
- * The namespace for the MongoService.
- *
- * @namespace MongoService
- */
-export declare namespace MongoService {
-    interface Options {
-        db?: MongoService<any>['db'];
-        collectionName?: MongoService<any>['collectionName'];
-        resourceName?: MongoService<any>['resourceName'];
-        session?: MongoService<any>['session'];
-        idGenerator?: MongoService<any>['$idGenerator'];
-        onError?: MongoService<any>['$onError'];
-    }
-    type CrudOp = 'create' | 'read' | 'update' | 'delete';
+    protected _getDocumentFilter(info: MongoService.CommandInfo): MongoAdapter.FilterInput | Promise<MongoAdapter.FilterInput> | undefined;
+    protected _intercept(callback: (...args: any[]) => any, info: MongoService.CommandInfo): Promise<any>;
 }