@opra/mongodb 1.0.0-alpha.9 → 1.0.0-beta.2

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

@@ -1,8 +1,7 @@
-import mongodb from 'mongodb';
-import { PartialDTO, PatchDTO, Type } from 'ts-gems';
+import mongodb, { type UpdateFilter } from 'mongodb';
+import type { PartialDTO, PatchDTO, RequiredSome, Type } from 'ts-gems';
 import { MongoAdapter } from './mongo-adapter.js';
 import { MongoEntityService } from './mongo-entity-service.js';
-import { MongoService } from './mongo-service.js';
 /**
  *
  * @namespace MongoSingletonService
@@ -17,16 +16,6 @@ export declare namespace MongoSingletonService {
     interface Options extends MongoEntityService.Options {
         _id?: MongoAdapter.AnyId;
     }
-    interface CreateOptions extends MongoEntityService.CreateOptions {
-    }
-    interface DeleteOptions<T> extends MongoEntityService.DeleteOptions<T> {
-    }
-    interface ExistsOptions<T> extends MongoService.ExistsOptions<T> {
-    }
-    interface FindOneOptions<T> extends MongoEntityService.FindOneOptions<T> {
-    }
-    interface UpdateOptions<T> extends MongoEntityService.UpdateOptions<T> {
-    }
 }
 /**
  * A class that provides access to a MongoDB collection, with support for singleton document operations.
@@ -51,64 +40,78 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
     /**
      * Asserts the existence of a resource based on the given options.
      *
-     * @param {MongoSingletonService.ExistsOptions<T>} [options]
+     * @param {MongoEntityService.ExistsOptions<T>} [options]
      * @returns {Promise<void>} A Promise that resolves when the resource exists.
      * @throws {ResourceNotAvailableError} If the resource does not exist.
      */
-    assert(options?: MongoSingletonService.ExistsOptions<T>): Promise<void>;
+    assert(options?: MongoEntityService.ExistsOptions<T>): Promise<void>;
     /**
      * Creates the document in the database.
      *
      * @param {PartialDTO<T>} input - The partial input to create the document with.
-     * @param {MongoSingletonService.CreateOptions} [options] - The options for creating the document.
+     * @param {MongoEntityService.CreateOptions} [options] - The options for creating the 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: PartialDTO<T>, options?: MongoSingletonService.CreateOptions): Promise<PartialDTO<T>>;
+    create(input: PartialDTO<T>, options: RequiredSome<MongoEntityService.CreateOptions, 'projection'>): Promise<PartialDTO<T>>;
+    create(input: PartialDTO<T>, options?: MongoEntityService.CreateOptions): Promise<T>;
+    /**
+     * Creates the document in the database.
+     *
+     * @param {DTO<T>} input - The partial input to create the document with.
+     * @param {MongoEntityService.CreateOptions} [options] - The options for creating the document.
+     * @returns {Promise<T>} A promise that resolves create operation result
+     * @throws {Error} Throws an error if an unknown error occurs while creating the document.
+     */
+    createOnly(input: PartialDTO<T>, options?: MongoEntityService.CreateOptions): Promise<T>;
     /**
      * Deletes a record from the database
      *
-     * @param {MongoSingletonService.DeleteOptions<T>} options - The options for deleting the record
+     * @param {MongoEntityService.DeleteOptions<T>} options - The options for deleting the record
      * @returns {Promise<number>} The number of records deleted
      */
-    delete(options?: MongoSingletonService.DeleteOptions<T>): Promise<number>;
+    delete(options?: MongoEntityService.DeleteOptions<T>): Promise<number>;
     /**
      * Checks if the document exists in the database.
      *
+     * @param {MongoEntityService.FindOneOptions<T>} [options] - The options for finding the document.
      * @return {Promise<boolean>} - A promise that resolves to a boolean value indicating if the document exists.
      */
-    exists(options?: MongoSingletonService.ExistsOptions<T>): Promise<boolean>;
+    exists(options?: MongoEntityService.ExistsOptions<T>): Promise<boolean>;
     /**
      * Fetches the document if it exists. Returns undefined if not found.
      *
-     * @param {MongoSingletonService.FindOneOptions<T>} [options] - The options for finding the document.
+     * @param {MongoEntityService.FindOneOptions<T>} [options] - The options for finding the document.
      * @returns {Promise<PartialDTO<T> | undefined>} - A promise that resolves to the found document or undefined if not found.
      */
-    find(options?: MongoSingletonService.FindOneOptions<T>): Promise<PartialDTO<T> | undefined>;
+    find(options: RequiredSome<MongoEntityService.FindOneOptions<T>, 'projection'>): Promise<PartialDTO<T> | undefined>;
+    find(options?: MongoEntityService.FindOneOptions<T>): Promise<T | undefined>;
     /**
      * Fetches the document from the Mongo collection service. Throws error if not found.
      *
-     * @param {MongoSingletonService.FindOneOptions<T>} options - The options to customize the query.
+     * @param {MongoEntityService.FindOneOptions<T>} options - The options to customize the query.
      * @return {Promise<PartialDTO<T>>} - A promise that resolves to the fetched document.
      * @throws {ResourceNotAvailableError} - If the document is not found in the collection.
      */
-    get(options?: MongoSingletonService.FindOneOptions<T>): Promise<PartialDTO<T>>;
+    get(options: RequiredSome<MongoEntityService.FindOneOptions<T>, 'projection'>): Promise<PartialDTO<T>>;
+    get(options?: MongoEntityService.FindOneOptions<T>): Promise<T>;
     /**
      * 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.
+     * @param {MongoEntityService.UpdateOneOptions<T>} [options] - The update options.
      *
-     * @return {Promise<number>} - A promise that resolves to the updated document or undefined if not found.
+     * @return {Promise<PartialDTO<T> | undefined>} - A promise that resolves to the updated document or undefined if not found.
      */
-    updateOnly(input: PatchDTO<T>, options?: MongoSingletonService.UpdateOptions<T>): Promise<number>;
+    update(input: PatchDTO<T> | UpdateFilter<T>, options: RequiredSome<MongoEntityService.UpdateOneOptions<T>, 'projection'>): Promise<PartialDTO<T> | undefined>;
+    update(input: PatchDTO<T> | UpdateFilter<T>, options?: MongoEntityService.UpdateOneOptions<T>): Promise<T | undefined>;
     /**
      * 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.
+     * @param {MongoEntityService.UpdateOneOptions<T>} [options] - The update options.
      *
-     * @return {Promise<PartialDTO<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: PatchDTO<T>, options?: MongoSingletonService.UpdateOptions<T>): Promise<PartialDTO<T> | undefined>;
+    updateOnly(input: PatchDTO<T> | UpdateFilter<T>, options?: MongoEntityService.UpdateOneOptions<T>): Promise<number>;
 }