@opra/mongodb 0.32.2 → 0.32.3

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

@@ -1,6 +1,5 @@
 import mongodb from 'mongodb';
 import { StrictOmit, Type } from 'ts-gems';
-import vg from 'valgen';
 import * as OpraCommon from '@opra/common';
 import { ComplexType, PartialInput } from '@opra/common';
 import { PartialOutput } from '@opra/core';
@@ -8,169 +7,240 @@ import { MongoCollectionService } from './mongo-collection-service.js';
 import { MongoService } from './mongo-service.js';
 import { AnyId } from './types.js';
 /**
- *
- * @class MongoArrayService
+ * A class that provides methods to perform operations on an array field in a MongoDB collection.
+ * @template T The type of the array item.
  */
 export declare class MongoArrayService<T extends mongodb.Document> extends MongoService<T> {
-    protected _encoders: Record<string, vg.Validator>;
+    /**
+     * Represents the key for a collection.
+     *
+     * @type {string}
+     */
     collectionKey: string;
-    arrayKey: string;
-    defaultLimit: number;
+    /**
+     * Represents the name of the array field in parent document
+     *
+     * @type {string} FieldName
+     */
     fieldName: string;
-    constructor(dataType: Type | string, fieldName: string, options?: MongoArrayService.Options);
-    getArrayDataType(): ComplexType;
     /**
-     * Checks if array item exists. Throws error if not.
+     * Represents the key field of an array.
+     *
+     * @type {string} arrayKey
+     */
+    arrayKey: string;
+    /**
+     * Represents the default limit value for a certain operation.
      *
-     * @param parentId
-     * @param id
+     * @type {number}
      */
-    assert(parentId: AnyId, id: AnyId): Promise<void>;
+    defaultLimit: number;
+    constructor(dataType: Type | string, fieldName: string, options?: MongoArrayService.Options);
     /**
-     * Adds a single item into array field.
+     * Retrieves the data type of the array field
      *
-     * @param parentId
-     * @param input
-     * @param options
+     * @returns {ComplexType} The complex data type of the field.
+     * @throws {NotAcceptableError} If the data type is not a ComplexType.
      */
-    create(parentId: AnyId, input: T, options?: MongoArrayService.CreateOptions): Promise<PartialOutput<T>>;
+    getDataType(): ComplexType;
     /**
-     * Gets the number of array items matching the filter.
-     * @param parentId
-     * @param options
+     * Asserts whether a resource with the specified parentId and id exists.
+     * Throws a ResourceNotFoundError if the resource does not exist.
+     *
+     * @param {AnyId} documentId - The ID of the parent document.
+     * @param {AnyId} id - The ID of the resource.
+     * @return {Promise<void>} - A promise that resolves with no value upon success.
+     * @throws {ResourceNotFoundError} - If the resource does not exist.
      */
-    count(parentId: AnyId, options?: MongoArrayService.CountOptions<T>): Promise<number>;
+    assert(documentId: AnyId, id: AnyId): Promise<void>;
     /**
-     * Removes one item from an array field
+     * Adds a single item into the array field.
      *
-     * @param parentId
-     * @param id
-     * @param options
+     * @param {AnyId} documentId - The ID of the parent document.
+     * @param {T} input - The item to be added to the array field.
+     * @param {MongoArrayService.CreateOptions} [options] - Optional options for the create operation.
+     * @return {Promise<PartialOutput<T>>} - A promise that resolves with the partial output of the created item.
+     * @throws {ResourceNotFoundError} - If the parent document is not found.
      */
-    delete(parentId: AnyId, id: AnyId, options?: MongoArrayService.DeleteOptions<T>): Promise<number>;
+    create(documentId: AnyId, input: T, options?: MongoArrayService.CreateOptions): Promise<PartialOutput<T>>;
     /**
-     * Removes multiple items from an array field
+     * Counts the number of documents in the collection that match the specified parentId and options.
      *
-     * @param parentId
-     * @param options
+     * @param {AnyId} documentId - The ID of the parent document.
+     * @param {object} options - Optional parameters for counting.
+     * @param {object} options.filter - The filter object to apply to the count operation.
+     * @returns {Promise<number>} - A promise that resolves to the count of documents.
      */
-    deleteMany(parentId: AnyId, options?: MongoArrayService.DeleteManyOptions<T>): Promise<number>;
+    count(documentId: AnyId, options?: MongoArrayService.CountOptions<T>): Promise<number>;
     /**
-     * Returns true if item exists, false otherwise
+     * Deletes an element from an array within a document in the MongoDB collection.
      *
-     * @param parentId
-     * @param id
+     * @param {AnyId} documentId - The ID of the parent document.
+     * @param {AnyId} id - The ID of the element to delete from the array.
+     * @param {MongoArrayService.DeleteOptions<T>} [options] - Additional options for the delete operation.
+     * @return {Promise<number>} - A Promise that resolves to the number of elements deleted (1 if successful, 0 if not).
      */
-    exists(parentId: AnyId, id: AnyId): Promise<boolean>;
+    delete(documentId: AnyId, id: AnyId, options?: MongoArrayService.DeleteOptions<T>): Promise<number>;
     /**
-     * Fetches the first item in an array field that matches by id.
+     * Deletes multiple items from a collection based on the parent ID and optional filter.
      *
-     * @param parentId
-     * @param id
-     * @param options
+     * @param {AnyId} documentId - The ID of the parent document.
+     * @param {MongoArrayService.DeleteManyOptions<T>} options - Optional options to specify a filter.
+     * @returns {Promise<number>} - A Promise that resolves to the number of items deleted.
      */
-    findById(parentId: AnyId, id: AnyId, options?: MongoArrayService.FindOneOptions): Promise<PartialOutput<T> | undefined>;
+    deleteMany(documentId: AnyId, options?: MongoArrayService.DeleteManyOptions<T>): Promise<number>;
     /**
-     * Fetches the first item in an array field that matches the filter. Returns undefined if not found.
+     * Checks if an array element with the given parentId and id exists.
      *
-     * @param parentId
-     * @param options
+     * @param {AnyId} documentId - The ID of the parent document.
+     * @param {AnyId} id - The id of the record.
+     * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating if the record exists or not.
      */
-    findOne(parentId: AnyId, options?: MongoArrayService.FindOneOptions): Promise<PartialOutput<T> | undefined>;
+    exists(documentId: AnyId, id: AnyId): Promise<boolean>;
     /**
-     * Fetches all items in an array field that matches the filter
+     * Finds an element in array field by its parent ID and ID.
      *
-     * @param parentId
-     * @param options
+     * @param {AnyId} documentId - The ID of the document.
+     * @param {AnyId} id - The ID of the document.
+     * @param {MongoArrayService.FindOneOptions} [options] - The optional options for the operation.
+     * @returns {Promise<PartialOutput<T> | undefined>} - A promise that resolves to the found document or undefined if not found.
      */
-    findMany(parentId: AnyId, options?: MongoArrayService.FindManyOptions<T>): Promise<PartialOutput<T>[] | undefined>;
+    findById(documentId: AnyId, id: AnyId, options?: MongoArrayService.FindOneOptions): Promise<PartialOutput<T> | undefined>;
     /**
-     * Fetches the first item in an array field that matches the item id. Throws error undefined if not found.
+     * Finds the first array element that matches the given parentId.
      *
-     * @param parentId
-     * @param id
-     * @param options
+     * @param {AnyId} documentId - The ID of the document.
+     * @param {MongoArrayService.FindOneOptions} [options] - Optional options to customize the query.
+     * @returns {Promise<PartialOutput<T> | undefined>} A promise that resolves to the first matching document, or `undefined` if no match is found.
      */
-    get(parentId: AnyId, id: AnyId, options?: MongoArrayService.FindOneOptions<T>): Promise<PartialOutput<T>>;
+    findOne(documentId: AnyId, options?: MongoArrayService.FindOneOptions): Promise<PartialOutput<T> | undefined>;
     /**
-     * Update a single item in array field
+     * Finds multiple elements in an array field.
      *
-     * @param parentId
-     * @param id
-     * @param input
-     * @param options
+     * @param {AnyId} documentId - The ID of the parent document.
+     * @param {MongoArrayService.FindManyOptions<T>} [options] - The options for finding the documents.
+     * @returns {Promise<PartialOutput<T>[] | undefined>} - The found documents.
      */
-    update(parentId: AnyId, id: AnyId, input: PartialInput<T>, options?: MongoArrayService.UpdateOptions<T>): Promise<PartialOutput<T> | undefined>;
+    findMany(documentId: AnyId, options?: MongoArrayService.FindManyOptions<T>): Promise<PartialOutput<T>[] | undefined>;
     /**
-     * Update a single item in array field
-     * Returns how many master documents updated (not array items)
+     * Retrieves a specific item from the array of a document.
      *
-     * @param parentId
-     * @param id
-     * @param doc
-     * @param options
+     * @param {AnyId} documentId - The ID of the document.
+     * @param {AnyId} id - The ID of the item.
+     * @param {MongoArrayService.FindOneOptions<T>} [options] - The options for finding the item.
+     * @returns {Promise<PartialOutput<T>>} - The item found.
+     * @throws {ResourceNotFoundError} - If the item is not found.
      */
-    updateOnly(parentId: AnyId, id: AnyId, doc: PartialInput<T>, options?: MongoArrayService.UpdateOptions<T>): Promise<number>;
+    get(documentId: AnyId, id: AnyId, options?: MongoArrayService.FindOneOptions<T>): Promise<PartialOutput<T>>;
     /**
-     * Update multiple items in array field, returns how many master documents updated (not array items)
+     * Updates an array element with new data and returns the updated element
      *
-     * @param parentId
-     * @param input
-     * @param options
+     * @param {AnyId} documentId - The ID of the document to update.
+     * @param {AnyId} id - The ID of the item to update within the document.
+     * @param {PartialInput<T>} input - The new data to update the item with.
+     * @param {MongoArrayService.UpdateOptions<T>} [options] - Additional update options.
+     * @returns {Promise<PartialOutput<T> | undefined>} The updated item or undefined if it does not exist.
+     * @throws {Error} If an error occurs while updating the item.
      */
-    updateMany(parentId: AnyId, input: PartialInput<T>, options?: MongoArrayService.UpdateManyOptions<T>): Promise<number>;
+    update(documentId: AnyId, id: AnyId, input: PartialInput<T>, options?: MongoArrayService.UpdateOptions<T>): Promise<PartialOutput<T> | undefined>;
     /**
-     * Update multiple items in array field and returns number of updated array items
+     * Update an array element with new data. Returns 1 if document updated 0 otherwise.
      *
-     * @param parentId
-     * @param doc
-     * @param options
+     * @param {AnyId} documentId - The ID of the parent document.
+     * @param {AnyId} id - The ID of the document to update.
+     * @param {PartialInput<T>} doc - The partial input object containing the fields to update.
+     * @param {MongoArrayService.UpdateOptions<T>} [options] - Optional update options.
+     * @returns {Promise<number>} - A promise that resolves to the number of elements updated.
      */
-    updateManyReturnCount(parentId: AnyId, doc: PartialInput<T>, options?: MongoArrayService.UpdateManyOptions<T>): Promise<number>;
+    updateOnly(documentId: AnyId, id: AnyId, doc: PartialInput<T>, options?: MongoArrayService.UpdateOptions<T>): Promise<number>;
     /**
-     * Generates Id value
+     * Updates multiple array elements in document
      *
-     * @protected
+     * @param {AnyId} documentId - The ID of the document to update.
+     * @param {PartialInput<T>} input - The updated data for the document(s).
+     * @param {MongoArrayService.UpdateManyOptions<T>} [options] - Additional options for the update operation.
+     * @returns {Promise<number>} - A promise that resolves to the number of documents updated.
      */
-    protected _generateId(): AnyId;
+    updateMany(documentId: AnyId, input: PartialInput<T>, options?: MongoArrayService.UpdateManyOptions<T>): Promise<number>;
     /**
-     * Generates a new Validator  for encoding or returns from cache if already generated before
-     * @param operation
-     * @protected
+     * Updates multiple elements and returns the count of elements that were updated.
+     *
+     * @param {AnyId} documentId - The ID of the document to update.
+     * @param {PartialInput<T>} doc - The partial document to update with.
+     * @param {MongoArrayService.UpdateManyOptions<T>} [options] - The options for updating multiple documents.
+     * @return {Promise<number>} A promise that resolves to the number of elements updated.
      */
-    protected _getEncoder(operation: 'create' | 'update'): vg.Validator;
+    updateManyReturnCount(documentId: AnyId, doc: PartialInput<T>, options?: MongoArrayService.UpdateManyOptions<T>): Promise<number>;
     /**
-     * Generates a new Valgen Validator for encode operation
+     * Generates a new id for new inserting Document.
      *
-     * @param operation
      * @protected
+     * @returns {AnyId} A new instance of AnyId.
      */
-    protected _generateEncoder(operation: 'create' | 'update'): vg.Validator;
+    protected _generateId(): AnyId;
 }
 /**
  *
  * @namespace MongoArrayService
  */
 export declare namespace MongoArrayService {
+    /**
+     * The constructor options of MongoArrayService.
+     */
     interface Options extends MongoCollectionService.Options {
         arrayKey?: string;
     }
+    /**
+     * Represents options for creating objects.
+     *
+     * @interface
+     */
     interface CreateOptions extends mongodb.UpdateOptions {
         pick?: string[];
         omit?: string[];
         include?: string[];
     }
+    /**
+     * Represents options for counting a new object.
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
     interface CountOptions<T> extends mongodb.AggregateOptions {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
+    /**
+     * Represents options for deleting single object.
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
     interface DeleteOptions<T> extends mongodb.UpdateOptions {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
+    /**
+     * Represents options for deleting multiple objects.
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
     interface DeleteManyOptions<T> extends mongodb.UpdateOptions {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
+    /**
+     * Represents options for finding single object.
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
     interface FindOneOptions<T = any> extends StrictOmit<FindManyOptions<T>, 'count' | 'limit'> {
     }
+    /**
+     * Represents options for finding multiple objects.
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
     interface FindManyOptions<T> extends mongodb.AggregateOptions {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
         pick?: string[];
@@ -181,12 +251,24 @@ export declare namespace MongoArrayService {
         limit?: number;
         skip?: number;
     }
+    /**
+     * Represents options for updating single object.
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
     interface UpdateOptions<T> extends mongodb.UpdateOptions {
         pick?: string[];
         omit?: string[];
         include?: string[];
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
+    /**
+     * Represents options for updating multiple objects.
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
     interface UpdateManyOptions<T> extends mongodb.UpdateOptions {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }

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

@@ -1,155 +1,216 @@
 import mongodb from 'mongodb';
 import { StrictOmit, Type } from 'ts-gems';
-import vg from 'valgen';
 import * as OpraCommon from '@opra/common';
 import { PartialInput, PartialOutput } from '@opra/core';
 import { MongoService } from './mongo-service.js';
 import { AnyId } from './types.js';
 /**
- *
  * @class MongoCollectionService
+ * @template T - The type of the documents in the collection.
  */
 export declare class MongoCollectionService<T extends mongodb.Document> extends MongoService<T> {
-    protected _encoders: Record<string, vg.Validator>;
+    /**
+     * Represents the key for a collection.
+     *
+     * @type {string}
+     */
     collectionKey: string;
+    /**
+     * Represents the default limit value for a certain operation.
+     *
+     * @type {number}
+     */
     defaultLimit: number;
     constructor(dataType: Type | string, options?: MongoCollectionService.Options);
     /**
-     * Checks if document exists. Throws error if not.
+     * Asserts the existence of a resource with the given ID.
+     * Throws a ResourceNotFoundError if the resource does not exist.
      *
-     * @param id
+     * @param {AnyId} id - The ID of the resource to assert.
+     * @returns {Promise<void>} - A Promise that resolves when the resource exists.
+     * @throws {ResourceNotFoundError} - If the resource does not exist.
      */
     assert(id: AnyId): Promise<void>;
     /**
-     * Inserts a single document into MongoDB
+     * Creates a new document in the MongoDB collection.
      *
-     * @param input
-     * @param options
+     * @param {PartialInput<T>} input - The input data for creating the document.
+     * @param {MongoCollectionService.CreateOptions} [options] - The options for creating the document.
+     * @returns {Promise<PartialOutput<T>>} A promise that resolves to the created document.
+     * @throws {Error} if an unknown error occurs while creating the document.
      */
     create(input: PartialInput<T>, options?: MongoCollectionService.CreateOptions): Promise<PartialOutput<T>>;
     /**
-     * Gets the number of documents matching the filter.
+     * Returns the count of documents in the collection based on the provided options.
      *
-     * @param options
+     * @param {MongoCollectionService.CountOptions<T>} options - The options for the count operation.
+     * @return {Promise<number>} - A promise that resolves to the count of documents in the collection.
      */
     count(options?: MongoCollectionService.CountOptions<T>): Promise<number>;
     /**
-     * Delete a document from a collection
+     * Deletes a document from the collection.
      *
-     * @param id
-     * @param options
+     * @param {AnyId} id - The ID of the document to delete.
+     * @param {MongoCollectionService.DeleteOptions<T>} [options] - Optional delete options.
+     * @return {Promise<number>} - A Promise that resolves to the number of documents deleted.
      */
     delete(id: AnyId, options?: MongoCollectionService.DeleteOptions<T>): Promise<number>;
     /**
-     * Delete multiple documents from a collection
+     * Deletes multiple documents from the collection that meet the specified filter criteria.
      *
-     * @param options
+     * @param {MongoCollectionService.DeleteManyOptions<T>} options - The options for the delete operation.
+     * @return {Promise<number>} - A promise that resolves to the number of documents deleted.
      */
     deleteMany(options?: MongoCollectionService.DeleteManyOptions<T>): Promise<number>;
     /**
-     * Checks if document exists.
-     * Returns true if document exists, false otherwise
+     * Checks if an object with the given id exists.
      *
-     * @param id
+     * @param {AnyId} id - The id of the object to check.
+     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the object exists or not.
      */
     exists(id: AnyId): Promise<boolean>;
     /**
-     * Fetches the first document matches by id.
+     * Finds a document by its ID.
      *
-     * @param id
-     * @param options
+     * @param {AnyId} id - The ID of the document.
+     * @param {MongoCollectionService.FindOneOptions} [options] - The options for the find query.
+     * @return {Promise<PartialOutput<T | undefined>>} - A promise resolving to the found document, or undefined if not found.
      */
     findById(id: AnyId, options?: MongoCollectionService.FindOneOptions): Promise<PartialOutput<T | undefined>>;
     /**
-     * Fetches the first document that matches the filter.
-     * Returns undefined if not found.
+     * Finds a document in the collection that matches the specified options.
      *
-     * @param options
+     * @param {MongoCollectionService.FindOneOptions} options - The options for the query.
+     * @return {Promise<PartialOutput<T> | undefined>} A promise that resolves with the found document or undefined if no document is found.
      */
     findOne(options?: MongoCollectionService.FindOneOptions): Promise<PartialOutput<T> | undefined>;
     /**
-     * Fetches all document that matches the filter
+     * Finds multiple documents in the MongoDB collection.
+     *
+     * @param options - The options for the find operation.
+     *  - pick: string[] - An array of fields to include in the returned documents.
+     *  - include: string[] - An array of fields to include in the returned documents.
+     *  - omit: string[] - An array of fields to exclude from the returned documents.
+     *  - sort: Record<string, number> - The sorting criteria.
+     *  - skip: number - The number of documents to skip.
+     *  - limit: number - The maximum number of documents to return.
+     *  - filter: FilterQuery<T> - The filter conditions to apply to the find operation.
+     *  - count: boolean - If set to true, returns the total count of matching documents.
      *
-     * @param options
+     * @return A Promise that resolves to an array of partial outputs of type T.
      */
     findMany(options?: MongoCollectionService.FindManyOptions<T>): Promise<PartialOutput<T>[]>;
     /**
-     * Fetches the first Document that matches the id. Throws error undefined if not found.
+     * Retrieves a document from the collection by its ID. Throws error if not found.
      *
-     * @param id
-     * @param options
+     * @param {*} id - The ID of the document to retrieve.
+     * @param {MongoCollectionService.FindOneOptions} [options] - Optional options for the findOne operation.
+     * @returns {Promise<PartialOutput<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.
      */
     get(id: AnyId, options?: MongoCollectionService.FindOneOptions): Promise<PartialOutput<T>>;
     /**
-     * Updates a single document.
-     * Returns updated document
+     * Updates a document with the given id in the collection.
      *
-     * @param id
-     * @param input
-     * @param options
+     * @param {any} id - The id of the document to update.
+     * @param {PartialInput<T>} input - The partial input object containing the fields to update.
+     * @param {MongoCollectionService.UpdateOptions<T>} [options] - The options for the update operation.
+     * @returns {Promise<PartialOutput<T> | undefined>} A promise that resolves to the updated document or
+     * undefined if the document was not found.
      */
     update(id: any, input: PartialInput<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<PartialOutput<T> | undefined>;
     /**
-     * Updates a single document
-     * Returns number of updated documents
+     * Updates a document in the collection with the specified ID.
      *
-     * @param id
-     * @param input
-     * @param options
+     * @param {any} id - The ID of the document to update.
+     * @param {PartialInput<T>} input - The partial input data to update the document with.
+     * @param {MongoCollectionService.UpdateOptions<T>} options - The options for updating the document.
+     * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
      */
     updateOnly(id: any, input: PartialInput<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<number>;
     /**
-     *  Update multiple documents in a collection
+     * Updates multiple documents in the collection based on the specified input and options.
      *
-     * @param input
-     * @param options
+     * @param {OpraCommon.PartialInput<T>} input - The partial input to update the documents with.
+     * @param {MongoCollectionService.UpdateManyOptions<T>} options - The options for updating the documents.
+     * @return {Promise<number>} - A promise that resolves to the number of documents matched and modified.
      */
     updateMany(input: OpraCommon.PartialInput<T>, options?: MongoCollectionService.UpdateManyOptions<T>): Promise<number>;
     /**
-     * Generates Id value
+     * Generates a new id for new inserting Document.
      *
      * @protected
+     * @returns {AnyId} A new instance of AnyId.
      */
     protected _generateId(): AnyId;
-    /**
-     * Generates a new Validator  for encoding or returns from cache if already generated before
-     * @param operation
-     * @protected
-     */
-    protected _getEncoder(operation: 'create' | 'update'): vg.Validator;
-    /**
-     * Generates a new Valgen Validator for encode operation
-     *
-     * @param operation
-     * @protected
-     */
-    protected _generateEncoder(operation: 'create' | 'update'): vg.Validator;
 }
 /**
  *
  * @namespace MongoCollectionService
  */
 export declare namespace MongoCollectionService {
+    /**
+     * The constructor options of MongoCollectionService.
+     *
+     * @interface Options
+     * @extends MongoService.Options
+     */
     interface Options extends MongoService.Options {
         collectionKey?: string;
         defaultLimit?: number;
     }
+    /**
+     * Represents options for creating a new document.
+     *
+     * @interface
+     */
     interface CreateOptions extends mongodb.InsertOneOptions {
         pick?: string[];
         omit?: string[];
         include?: string[];
     }
+    /**
+     * Represents options for counting document.
+     *
+     * @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 deleting single document.
+     *
+     * @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 deleting multiple documents.
+     *
+     * @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 finding single document.
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
     interface FindOneOptions<T = any> extends StrictOmit<FindManyOptions<T>, 'count' | 'limit'> {
     }
+    /**
+     * Represents options for finding multiple documents.
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
     interface FindManyOptions<T> extends mongodb.AggregateOptions {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
         pick?: string[];
@@ -160,12 +221,24 @@ export declare namespace MongoCollectionService {
         skip?: number;
         count?: boolean;
     }
+    /**
+     * Represents options for updating single document.
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
     interface UpdateOptions<T> extends StrictOmit<mongodb.FindOneAndUpdateOptions, 'projection' | 'returnDocument' | 'includeResultMetadata'> {
         pick?: string[];
         omit?: string[];
         include?: string[];
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
+    /**
+     * Represents options for updating multiple documents.
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
     interface UpdateManyOptions<T> extends StrictOmit<mongodb.UpdateOptions, 'upsert'> {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }