@opra/mongodb 1.0.0-alpha.2 → 1.0.0-alpha.21

package/types/mongo-service.d.ts

@@ -1,9 +1,9 @@
-import mongodb, { Document, TransactionOptions } from 'mongodb';
-import { PartialDTO, StrictOmit, Type } from 'ts-gems';
-import { IsObject } from 'valgen';
 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 { MongoAdapter } from './mongo-adapter.js';
 /**
  * The namespace for the MongoService.
@@ -14,12 +14,12 @@ 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'];
+        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 {
@@ -28,8 +28,8 @@ export declare namespace MongoService {
         byId: boolean;
         documentId?: MongoAdapter.AnyId;
         nestedId?: MongoAdapter.AnyId;
-        input?: Record<string, any>;
-        options?: Record<string, any>;
+        input?: any;
+        options?: any;
     }
     /**
      * Represents options for "create" operation
@@ -37,7 +37,7 @@ export declare namespace MongoService {
      * @interface
      */
     interface CreateOptions extends mongodb.InsertOneOptions {
-        fields?: string[];
+        projection?: string[];
     }
     /**
      * Represents options for "count" operation
@@ -118,7 +118,7 @@ export declare namespace MongoService {
      * @interface
      * @template T - The type of the document.
      */
-    interface UpdateOptions<T> extends StrictOmit<mongodb.FindOneAndUpdateOptions, 'projection' | 'returnDocument' | 'includeResultMetadata'> {
+    interface UpdateOneOptions<T> extends StrictOmit<mongodb.FindOneAndUpdateOptions, 'projection' | 'returnDocument' | 'includeResultMetadata'> {
         projection?: string | string[] | Document;
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
@@ -132,24 +132,36 @@ export declare namespace MongoService {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
 }
+export interface MongoService {
+    /**
+     * Interceptor function for handling callback execution with provided arguments.
+     * @type Function
+     * @param next - The callback function to be intercepted.
+     * @param {MongoService.CommandInfo} command - 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?(next: () => any, command: MongoService.CommandInfo, _this: any): Promise<any>;
+}
 /**
  * Class representing a MongoDB service for interacting with a collection.
  * @extends ServiceBase
  * @template T - The type of the documents in the collection.
  */
 export declare class MongoService<T extends mongodb.Document = mongodb.Document> extends ServiceBase {
-    protected _encoders: Record<string, IsObject.Validator<T>>;
-    protected _decoder?: IsObject.Validator<T>;
-    protected _dataType: Type | string;
+    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.
      */
@@ -162,29 +174,20 @@ export declare class MongoService<T extends mongodb.Document = mongodb.Document>
      * Generates a new id for new inserting Document.
      *
      */
-    $idGenerator?: (_this: any) => MongoAdapter.AnyId;
+    idGenerator?: (command: MongoService.CommandInfo, _this: any) => MongoAdapter.AnyId;
     /**
      * Callback function for handling errors.
      *
      * @param {unknown} error - The error object.
      * @param _this - The context object.
      */
-    $onError?: (error: unknown, _this: any) => void | Promise<void>;
+    onError?: (error: unknown, _this: any) => void | Promise<void>;
     /**
-     * Represents a common filter function for a MongoEntityService.
+     * 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>;
+    documentFilter?: MongoAdapter.FilterInput | ((args: MongoService.CommandInfo, _this: this) => MongoAdapter.FilterInput | Promise<MongoAdapter.FilterInput> | undefined);
     /**
      * Constructs a new instance
      *
@@ -206,25 +209,25 @@ export declare class MongoService<T extends mongodb.Document = mongodb.Document>
      *
      * @protected
      * @returns {string} The resource name.
-     * @throws {Error} If the collection name is not defined.
+     * @throws {Error} If the resource name is not defined.
      */
     getResourceName(): string;
     /**
-     * Retrieves the data type of the document
+     * 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.
      *
@@ -354,7 +357,7 @@ export declare class MongoService<T extends mongodb.Document = mongodb.Document>
      * @protected
      * @returns {MongoAdapter.AnyId} The generated ID.
      */
-    protected _generateId(): MongoAdapter.AnyId;
+    protected _generateId(command: MongoService.CommandInfo): MongoAdapter.AnyId;
     /**
      * Retrieves the common filter used for querying documents.
      * This method is mostly used for security issues like securing multi-tenant applications.
@@ -363,6 +366,6 @@ export declare class MongoService<T extends mongodb.Document = mongodb.Document>
      * @returns {FilterInput | Promise<FilterInput> | undefined} The common filter or a Promise
      * that resolves to the common filter, or undefined if not available.
      */
-    protected _getDocumentFilter(info: MongoService.CommandInfo): MongoAdapter.FilterInput | Promise<MongoAdapter.FilterInput> | undefined;
-    protected _intercept(callback: (...args: any[]) => any, info: MongoService.CommandInfo): Promise<any>;
+    protected _getDocumentFilter(command: MongoService.CommandInfo): MongoAdapter.FilterInput | Promise<MongoAdapter.FilterInput> | undefined;
+    protected _executeCommand(command: MongoService.CommandInfo, commandFn: () => any): Promise<any>;
 }

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

@@ -1,8 +1,7 @@
-import mongodb from 'mongodb';
+import mongodb, { UpdateFilter } from 'mongodb';
 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';
 /**
  *
  * @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,65 @@ 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?: MongoEntityService.CreateOptions): Promise<PartialDTO<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?: MongoEntityService.FindOneOptions<T>): Promise<PartialDTO<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?: MongoEntityService.FindOneOptions<T>): Promise<PartialDTO<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?: MongoEntityService.UpdateOneOptions<T>): Promise<PartialDTO<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>;
 }