@opra/mongodb 0.33.13 → 1.0.0-alpha.2

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

@@ -1,60 +1,45 @@
 import mongodb from 'mongodb';
-import { StrictOmit, Type } from 'ts-gems';
-import { PartialDTO, PatchDTO } from '@opra/common';
-import * as OpraCommon from '@opra/common';
-import { FilterInput } from './adapter-utils/prepare-filter.js';
+import { PartialDTO, PatchDTO, Type } from 'ts-gems';
+import { MongoAdapter } from './mongo-adapter.js';
+import { MongoEntityService } from './mongo-entity-service.js';
 import { MongoService } from './mongo-service.js';
-import { AnyId } from './types.js';
+/**
+ *
+ * @namespace MongoSingletonService
+ */
+export declare namespace MongoSingletonService {
+    /**
+     * The constructor options of MongoSingletonService.
+     *
+     * @interface Options
+     * @extends MongoService.Options
+     */
+    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.
  * @class MongoSingletonService
  * @extends MongoService
  * @template T - The type of document stored in the collection
  */
-export declare class MongoSingletonService<T extends mongodb.Document> extends MongoService<T> {
+export declare class MongoSingletonService<T extends mongodb.Document> extends MongoEntityService<T> {
     /**
      * 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}
+     * @type {MongoAdapter.AnyId} _id
      */
-    $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.
-     *
-     * @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?: Record<string, any>;
-        options?: Record<string, any>;
-    }, _this: any) => Promise<any>;
+    _id: MongoAdapter.AnyId;
     /**
      * Constructs a new instance
      *
@@ -66,20 +51,20 @@ 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]
      * @returns {Promise<void>} A Promise that resolves when the resource exists.
      * @throws {ResourceNotAvailableError} If the resource does not exist.
      */
-    assert(options?: MongoSingletonService.ExistsOptions): Promise<void>;
+    assert(options?: MongoSingletonService.ExistsOptions<T>): Promise<void>;
     /**
      * Creates the document in the database.
      *
-     * @param {DTO<T>} input - The partial input to create the document with.
+     * @param {PartialDTO<T>} input - The partial input to create the document with.
      * @param {MongoSingletonService.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>>;
-    protected _create(input: PartialDTO<T>, options?: MongoSingletonService.CreateOptions): Promise<PartialDTO<T>>;
     /**
      * Deletes a record from the database
      *
@@ -87,29 +72,27 @@ 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.
      *
      * @return {Promise<boolean>} - A promise that resolves to a boolean value indicating if the document exists.
      */
-    exists(options?: MongoSingletonService.ExistsOptions): Promise<boolean>;
+    exists(options?: MongoSingletonService.ExistsOptions<T>): Promise<boolean>;
     /**
      * Fetches the document if it exists. Returns undefined if not found.
      *
-     * @param {MongoSingletonService.FindOptions<T>} [options] - The options for finding the document.
+     * @param {MongoSingletonService.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.
      */
-    findOne(options?: MongoSingletonService.FindOptions<T>): Promise<PartialDTO<T> | undefined>;
-    protected _findOne(options?: MongoSingletonService.FindOptions<T>): Promise<PartialDTO<T> | undefined>;
+    find(options?: MongoSingletonService.FindOneOptions<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.
+     * @param {MongoSingletonService.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.FindOptions<T>): Promise<PartialDTO<T>>;
+    get(options?: MongoSingletonService.FindOneOptions<T>): Promise<PartialDTO<T>>;
     /**
      * Updates a document in the MongoDB collection.
      *
@@ -119,7 +102,6 @@ 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.
      *
@@ -129,95 +111,4 @@ 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.
-     *
-     * @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(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>;
-}
-/**
- *
- * @namespace MongoSingletonService
- */
-export declare namespace MongoSingletonService {
-    /**
-     * The constructor options of MongoSingletonService.
-     *
-     * @interface Options
-     * @extends MongoService.Options
-     */
-    interface Options extends MongoService.Options {
-        collectionKey?: MongoSingletonService<any>['collectionKey'];
-        _id?: MongoSingletonService<any>['_id'];
-        documentFilter?: MongoSingletonService<any>['$documentFilter'];
-        interceptor?: MongoSingletonService<any>['$interceptor'];
-    }
-    /**
-     * Represents options for creating the document.
-     *
-     * @interface
-     */
-    interface CreateOptions extends mongodb.InsertOneOptions {
-        pick?: string[];
-        omit?: string[];
-        include?: string[];
-    }
-    /**
-     * Represents options for deleting the 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 finding the document.
-     *
-     * @interface
-     * @template T - The type of the document.
-     */
-    interface FindOptions<T> extends StrictOmit<mongodb.FindOptions, 'sort' | 'limit' | 'skip'> {
-        pick?: string[];
-        omit?: string[];
-        include?: string[];
-        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
-    }
-    /**
-     * Represents options for updating the document.
-     *
-     * @interface
-     * @template T - The type of the document.
-     */
-    interface UpdateOptions<T> extends mongodb.FindOneAndUpdateOptions {
-        pick?: string[];
-        omit?: string[];
-        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'> {
-    }
 }

package/cjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });