@opra/mongodb 0.32.3 → 0.32.4

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

@@ -1,8 +1,10 @@
 import mongodb from 'mongodb';
 import { StrictOmit, Type } from 'ts-gems';
+import { DTO, PartialDTO, PatchDTO } from '@opra/common';
 import * as OpraCommon from '@opra/common';
-import { PartialInput, PartialOutput } from '@opra/core';
+import { FilterInput } from './adapter-utils/prepare-filter.js';
 import { MongoService } from './mongo-service.js';
+import { AnyId } from './types.js';
 /**
  * A class that provides access to a MongoDB collection, with support for singleton document operations.
  * @class MongoSingletonService
@@ -10,13 +12,50 @@ import { MongoService } from './mongo-service.js';
  * @template T - The type of document stored in the collection
  */
 export declare class MongoSingletonService<T extends mongodb.Document> extends MongoService<T> {
-    protected _id: any;
+    /**
+     * Represents a unique identifier for singleton record
+     * @type {AnyId} _id
+     */
+    _id: AnyId;
     /**
      * Represents the key for a collection.
      *
      * @type {string}
      */
     collectionKey: string;
+    /**
+     * Represents a common filter function for a MongoCollectionService.
+     *
+     * @type {FilterInput | Function}
+     */
+    $documentFilter?: FilterInput | ((_this: this) => FilterInput | Promise<FilterInput> | undefined);
+    /**
+     * Interceptor function for handling callback execution with provided arguments.
+     *
+     * @param {Function} callback - The callback function to be intercepted.
+     * @param {Object} args - The arguments object containing the following properties:
+     *   @param {string} crud - The CRUD operation type.
+     *   @param {string} method - The method name.
+     *   @param {AnyId} documentId - The document ID (optional).
+     *   @param {Object} input - The input object (optional).
+     *   @param {Object} options - Additional options (optional).
+     * @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: {
+        crud: MongoService.CrudOp;
+        method: string;
+        documentId?: AnyId;
+        input?: Object;
+        options?: Record<string, any>;
+    }, _this: any) => Promise<any>;
+    /**
+     * Constructs a new instance
+     *
+     * @param {Type | string} dataType - The data type of the array elements.
+     * @param {MongoSingletonService.Options} [options] - The options for the array service.
+     * @constructor
+     */
     constructor(dataType: Type | string, options?: MongoSingletonService.Options);
     /**
      * Asserts the existence of a resource based on the given options.
@@ -24,16 +63,16 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
      * @returns {Promise<void>} A Promise that resolves when the resource exists.
      * @throws {ResourceNotFoundError} If the resource does not exist.
      */
-    assert(): Promise<void>;
+    assert(options?: MongoSingletonService.ExistsOptions): Promise<void>;
     /**
      * Creates the document in the database.
      *
-     * @param {PartialInput<T>} input - The partial input to create the document with.
+     * @param {DTO<T>} input - The partial input to create the document with.
      * @param {MongoSingletonService.CreateOptions} [options] - The options for creating the document.
-     * @return {Promise<PartialOutput<T>>} A promise that resolves to the partial output of the created document.
+     * @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: PartialInput<T>, options?: MongoSingletonService.CreateOptions): Promise<PartialOutput<T>>;
+    create(input: DTO<T>, options?: MongoSingletonService.CreateOptions): Promise<PartialDTO<T>>;
     /**
      * Deletes a record from the database
      *
@@ -46,31 +85,49 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
      *
      * @return {Promise<boolean>} - A promise that resolves to a boolean value indicating if the document exists.
      */
-    exists(): Promise<boolean>;
+    exists(options?: MongoSingletonService.ExistsOptions): Promise<boolean>;
     /**
      * Fetches the document if it exists. Returns undefined if not found.
      *
      * @param {MongoSingletonService.FindOptions<T>} [options] - The options for finding the document.
-     * @returns {Promise<PartialOutput<T> | undefined>} - A promise that resolves to the found document or undefined if not found.
+     * @returns {Promise<PartialDTO<T> | undefined>} - A promise that resolves to the found document or undefined if not found.
      */
-    findOne(options?: MongoSingletonService.FindOptions<T>): Promise<PartialOutput<T> | undefined>;
+    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<PartialOutput<T>>} - A promise that resolves to the fetched document.
+     * @return {Promise<PartialDTO<T>>} - A promise that resolves to the fetched document.
      * @throws {ResourceNotFoundError} - If the document is not found in the collection.
      */
-    get(options?: MongoSingletonService.FindOptions<T>): Promise<PartialOutput<T>>;
+    get(options?: MongoSingletonService.FindOptions<T>): Promise<PartialDTO<T>>;
     /**
      * Updates a document in the MongoDB collection.
      *
-     * @param {PartialInput<T>} input - The partial input to update the document.
+     * @param {PatchDTO<T>} input - The partial input to update the document.
      * @param {MongoSingletonService.UpdateOptions<T>} [options] - The update options.
      *
-     * @return {Promise<PartialOutput<T> | undefined>} - A promise that resolves to the updated document or undefined if not found.
+     * @return {Promise<number>} - A promise that resolves to the updated document or undefined if not found.
      */
-    update(input: PartialInput<T>, options?: MongoSingletonService.UpdateOptions<T>): Promise<PartialOutput<T> | undefined>;
+    updateOnly(input: PatchDTO<T>, options?: MongoSingletonService.UpdateOptions<T>): Promise<number>;
+    /**
+     * Updates a document in the MongoDB collection.
+     *
+     * @param {PatchDTO<T>} input - The partial input to update the document.
+     * @param {MongoSingletonService.UpdateOptions<T>} [options] - The update options.
+     *
+     * @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>;
+    /**
+     * Retrieves the common filter used for querying the document.
+     * This method is mostly used for security issues like securing multi-tenant applications.
+     *
+     * @protected
+     * @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;
 }
 /**
  *
@@ -84,8 +141,10 @@ export declare namespace MongoSingletonService {
      * @extends MongoService.Options
      */
     interface Options extends MongoService.Options {
-        collectionKey?: string;
-        _id?: any;
+        collectionKey?: MongoSingletonService<any>['collectionKey'];
+        _id?: MongoSingletonService<any>['_id'];
+        documentFilter?: MongoSingletonService<any>['$documentFilter'];
+        interceptor?: MongoSingletonService<any>['$interceptor'];
     }
     /**
      * Represents options for creating the document.
@@ -130,4 +189,11 @@ export declare namespace MongoSingletonService {
         include?: string[];
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
+    /**
+     * Represents options for checking the document exists
+     *
+     * @interface
+     */
+    interface ExistsOptions extends Omit<mongodb.CommandOperationOptions, 'writeConcern'> {
+    }
 }