@opra/mongodb 0.33.13 → 1.0.0-alpha.2

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

@@ -1,409 +0,0 @@
-import mongodb from 'mongodb';
-import { StrictOmit, Type } from 'ts-gems';
-import * as OpraCommon from '@opra/common';
-import { ComplexType, PartialDTO, PatchDTO } from '@opra/common';
-import { FilterInput } from './adapter-utils/prepare-filter.js';
-import { MongoService } from './mongo-service.js';
-import { AnyId } from './types.js';
-/**
- * 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> {
-    /**
-     * Represents the key for a collection.
-     *
-     * @type {string}
-     */
-    collectionKey: string;
-    /**
-     * Represents the name of the array field in parent document
-     *
-     * @type {string} FieldName
-     */
-    fieldName: string;
-    /**
-     * Represents the key field of an array.
-     *
-     * @type {string} arrayKey
-     */
-    arrayKey: string;
-    /**
-     * Represents the default limit value for a certain operation.
-     *
-     * @type {number}
-     */
-    defaultLimit: number;
-    /**
-     * Represents a common document filter function for a MongoCollectionService.
-     *
-     * @type {FilterInput
-     */
-    $documentFilter?: FilterInput | ((args: {
-        crud: MongoService.CrudOp;
-        method: string;
-        byId: boolean;
-        documentId?: AnyId;
-        itemId?: AnyId;
-        input?: Record<string, any>;
-        options?: Record<string, any>;
-    }, _this: this) => FilterInput | Promise<FilterInput> | undefined);
-    /**
-     * Represents a common array filter function for a MongoCollectionService.
-     *
-     * @type {FilterInput | Function}
-     */
-    $arrayFilter?: FilterInput | ((args: {
-        crud: MongoService.CrudOp;
-        method: string;
-        byId: boolean;
-        documentId?: AnyId;
-        itemId?: 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 callback - The callback function to be intercepted.
-     * @param args - The arguments object containing the following properties:
-     *   @param crud - The CRUD operation type.
-     *   @param method - The method name.
-     *   @param byId - True if current operation affects byId records (updateMany, deleteMany etc)
-     *   @param documentId - The document ID (optional).
-     *   @param itemId - ID for an item. (optional).
-     *   @param input - The input object (optional).
-     *   @param options - Additional options (optional).
-     * @param _this - The reference to the current object.
-     * @returns - The promise that resolves to the result of the callback execution.
-     */
-    $interceptor?: (callback: (...args: any[]) => any, args: {
-        crud: MongoService.CrudOp;
-        method: string;
-        documentId?: AnyId;
-        byId: boolean;
-        itemId?: AnyId;
-        input?: Record<string, any>;
-        options?: Record<string, any>;
-    }, _this: any) => Promise<any>;
-    /**
-     * Constructs a new instance
-     *
-     * @param {Type | string} dataType - The data type of the array elements.
-     * @param {string} fieldName - The name of the field in the document representing the array.
-     * @param {MongoArrayService.Options} [options] - The options for the array service.
-     * @constructor
-     */
-    constructor(dataType: Type | string, fieldName: string, options?: MongoArrayService.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.
-     * @param {MongoArrayService.ExistsOptions} [options] - Optional parameters for checking resource existence.
-     * @return {Promise<void>} - A promise that resolves with no value upon success.
-     * @throws {ResourceNotAvailableError} - If the resource does not exist.
-     */
-    assert(documentId: AnyId, id: AnyId, options?: MongoArrayService.ExistsOptions): Promise<void>;
-    /**
-     * Adds a single item into the array field.
-     *
-     * @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<PartialDTO<T>>} - A promise that resolves with the partial output of the created item.
-     * @throws {ResourceNotAvailableError} - If the parent document is not found.
-     */
-    create(documentId: AnyId, input: PartialDTO<T>, options?: MongoArrayService.CreateOptions): Promise<PartialDTO<T>>;
-    protected _create(documentId: AnyId, input: PartialDTO<T>, options?: MongoArrayService.CreateOptions): Promise<PartialDTO<T>>;
-    /**
-     * Counts the number of documents in the collection that match the specified parentId and 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.
-     */
-    count(documentId: AnyId, options?: MongoArrayService.CountOptions<T>): Promise<number>;
-    protected _count(documentId: AnyId, options?: MongoArrayService.CountOptions<T> & {
-        documentFilter?: FilterInput;
-    }): Promise<number>;
-    /**
-     * Deletes an element from an array within a document in the MongoDB collection.
-     *
-     * @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).
-     */
-    delete(documentId: AnyId, id: AnyId, options?: MongoArrayService.DeleteOptions<T>): Promise<number>;
-    protected _delete(documentId: AnyId, id: AnyId, options?: MongoArrayService.DeleteOptions<T> & {
-        documentFilter?: FilterInput;
-    }): Promise<number>;
-    /**
-     * Deletes multiple items from a collection based on the parent ID and optional filter.
-     *
-     * @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.
-     */
-    deleteMany(documentId: AnyId, options?: MongoArrayService.DeleteManyOptions<T>): Promise<number>;
-    protected _deleteMany(documentId: AnyId, options?: MongoArrayService.DeleteManyOptions<T> & {
-        documentFilter?: FilterInput;
-    }): Promise<number>;
-    /**
-     * Checks if an array element with the given parentId and id exists.
-     *
-     * @param {AnyId} documentId - The ID of the parent document.
-     * @param {AnyId} id - The id of the record.
-     * @param {MongoArrayService.ExistsOptions} [options] - The options for the exists method.
-     * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating if the record exists or not.
-     */
-    exists(documentId: AnyId, id: AnyId, options?: MongoArrayService.ExistsOptions): Promise<boolean>;
-    /**
-     * Finds an element in array field by its parent ID and ID.
-     *
-     * @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<PartialDTO<T> | undefined>} - A promise that resolves to the found document or undefined if not found.
-     */
-    findById(documentId: AnyId, id: AnyId, options?: MongoArrayService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
-    protected _findById(documentId: AnyId, id: AnyId, options?: MongoArrayService.FindOneOptions & {
-        documentFilter?: FilterInput;
-    }): Promise<PartialDTO<T> | undefined>;
-    /**
-     * Finds the first array element that matches the given parentId.
-     *
-     * @param {AnyId} documentId - The ID of the document.
-     * @param {MongoArrayService.FindOneOptions} [options] - Optional options to customize the query.
-     * @returns {Promise<PartialDTO<T> | undefined>} A promise that resolves to the first matching document, or `undefined` if no match is found.
-     */
-    findOne(documentId: AnyId, options?: MongoArrayService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
-    protected _findOne(documentId: AnyId, options?: MongoArrayService.FindOneOptions & {
-        documentFilter?: FilterInput;
-    }): Promise<PartialDTO<T> | undefined>;
-    /**
-     * Finds multiple elements in an array field.
-     *
-     * @param {AnyId} documentId - The ID of the parent document.
-     * @param {MongoArrayService.FindManyOptions<T>} [options] - The options for finding the documents.
-     * @returns {Promise<PartialDTO<T>[]>} - The found documents.
-     */
-    findMany(documentId: AnyId, options?: MongoArrayService.FindManyOptions<T>): Promise<PartialDTO<T>[]>;
-    protected _findMany(documentId: AnyId, options: MongoArrayService.FindManyOptions<T> & {
-        documentFilter?: FilterInput;
-        arrayFilter?: FilterInput;
-    }): Promise<PartialDTO<T>[]>;
-    /**
-     * Retrieves a specific item from the array of a document.
-     *
-     * @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<PartialDTO<T>>} - The item found.
-     * @throws {ResourceNotAvailableError} - If the item is not found.
-     */
-    get(documentId: AnyId, id: AnyId, options?: MongoArrayService.FindOneOptions<T>): Promise<PartialDTO<T>>;
-    /**
-     * Updates an array element with new data and returns the updated element
-     *
-     * @param {AnyId} documentId - The ID of the document to update.
-     * @param {AnyId} id - The ID of the item to update within the document.
-     * @param {PatchDTO<T>} input - The new data to update the item with.
-     * @param {MongoArrayService.UpdateOptions<T>} [options] - Additional update options.
-     * @returns {Promise<PartialDTO<T> | undefined>} The updated item or undefined if it does not exist.
-     * @throws {Error} If an error occurs while updating the item.
-     */
-    update(documentId: AnyId, id: AnyId, input: PatchDTO<T>, options?: MongoArrayService.UpdateOptions<T>): Promise<PartialDTO<T> | undefined>;
-    /**
-     * Update an array element with new data. Returns 1 if document updated 0 otherwise.
-     *
-     * @param {AnyId} documentId - The ID of the parent document.
-     * @param {AnyId} id - The ID of the document to update.
-     * @param {PatchDTO<T>} input - 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.
-     */
-    updateOnly(documentId: AnyId, id: AnyId, input: PatchDTO<T>, options?: MongoArrayService.UpdateOptions<T>): Promise<number>;
-    protected _updateOnly(documentId: AnyId, id: AnyId, input: PatchDTO<T>, options?: MongoArrayService.UpdateOptions<T> & {
-        documentFilter?: FilterInput;
-    }): Promise<number>;
-    /**
-     * Updates multiple array elements in document
-     *
-     * @param {AnyId} documentId - The ID of the document to update.
-     * @param {PatchDTO<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.
-     */
-    updateMany(documentId: AnyId, input: PatchDTO<T>, options?: MongoArrayService.UpdateManyOptions<T>): Promise<number>;
-    protected _updateMany(documentId: AnyId, input: PatchDTO<T>, options?: MongoArrayService.UpdateManyOptions<T> & {
-        documentFilter?: FilterInput;
-    }): Promise<number>;
-    /**
-     * Retrieves the data type of the array field
-     *
-     * @returns {ComplexType} The complex data type of the field.
-     * @throws {NotAcceptableError} If the data type is not a ComplexType.
-     */
-    getDataType(): ComplexType;
-    /**
-     * Generates an ID.
-     *
-     * @protected
-     * @returns {AnyId} The generated ID.
-     */
-    protected _generateId(): AnyId;
-    /**
-     * Retrieves the common filter used for querying documents.
-     * 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;
-        byId: boolean;
-        documentId?: AnyId;
-        itemId?: AnyId;
-        input?: Object;
-        options?: Record<string, any>;
-    }): FilterInput | Promise<FilterInput> | undefined;
-    /**
-     * Retrieves the common filter used for querying array elements.
-     * 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 _getArrayFilter(args: {
-        crud: MongoService.CrudOp;
-        method: string;
-        byId: boolean;
-        documentId?: AnyId;
-        itemId?: AnyId;
-        input?: Object;
-        options?: Record<string, any>;
-    }): FilterInput | Promise<FilterInput> | undefined;
-    protected _intercept(callback: (...args: any[]) => any, args: {
-        crud: MongoService.CrudOp;
-        method: string;
-        byId: boolean;
-        documentId?: AnyId;
-        itemId?: AnyId;
-        input?: Object;
-        options?: Record<string, any>;
-    }): Promise<any>;
-}
-/**
- *
- * @namespace MongoArrayService
- */
-export declare namespace MongoArrayService {
-    /**
-     * The constructor options of MongoArrayService.
-     */
-    interface Options extends MongoService.Options {
-        collectionKey?: MongoArrayService<any>['collectionKey'];
-        defaultLimit?: MongoArrayService<any>['defaultLimit'];
-        arrayKey?: MongoArrayService<any>['arrayKey'];
-        documentFilter?: MongoArrayService<any>['$documentFilter'];
-        arrayFilter?: MongoArrayService<any>['$arrayFilter'];
-        interceptor?: MongoArrayService<any>['$interceptor'];
-    }
-    /**
-     * 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[];
-        omit?: string[];
-        include?: string[];
-        sort?: string[];
-        count?: boolean;
-        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;
-        count?: boolean;
-    }
-    /**
-     * Represents options for checking the document exists
-     *
-     * @interface
-     */
-    interface ExistsOptions extends Omit<mongodb.CommandOperationOptions, 'writeConcern'> {
-    }
-}

package/types/types.d.ts

@@ -1,3 +0,0 @@
-import { ClientSession, ObjectId } from 'mongodb';
-export type AnyId = string | number | ObjectId;
-export type WithTransactionCallback = (session: ClientSession) => any;