@opra/mongodb 1.20.0 → 1.22.0

package/cjs/services/mongo-service.js

@@ -1,282 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MongoService = void 0;
-const common_1 = require("@opra/common");
-const core_1 = require("@opra/core");
-const mongodb_1 = require("mongodb");
-const mongo_adapter_js_1 = require("../adapter/mongo-adapter.js");
-const transactionKey = Symbol.for('transaction');
-/**
- * Class representing a MongoDB service for interacting with a collection.
- * @extends ServiceBase
- * @template T - The type of the documents in the collection.
- */
-class MongoService extends core_1.ServiceBase {
-    /**
-     * Constructs a new instance
-     *
-     * @param dataType - The data type of the returning results
-     * @param [options] - The options for the service
-     * @constructor
-     */
-    constructor(dataType, options) {
-        super();
-        this._inputCodecs = {};
-        this._outputCodecs = {};
-        this._dataType_ = dataType;
-        this.db = options?.db;
-        this.documentFilter = options?.documentFilter;
-        this.interceptor = options?.interceptor;
-        if (options?.collectionName)
-            this.collectionName = options?.collectionName;
-        else {
-            if (typeof dataType === 'string')
-                this.collectionName = dataType;
-            if (typeof dataType === 'function') {
-                const metadata = Reflect.getMetadata(common_1.DATATYPE_METADATA, dataType);
-                if (metadata)
-                    this.collectionName = metadata.name;
-            }
-        }
-        this.resourceName = options?.resourceName;
-        this.idGenerator = options?.idGenerator;
-        this.onError = options?.onError;
-    }
-    for(context, overwriteProperties, overwriteContext) {
-        if (overwriteProperties?.documentFilter && this.documentFilter) {
-            overwriteProperties.documentFilter = [
-                ...(Array.isArray(this.documentFilter)
-                    ? this.documentFilter
-                    : [this.documentFilter]),
-                ...(Array.isArray(overwriteProperties?.documentFilter)
-                    ? overwriteProperties.documentFilter
-                    : [overwriteProperties.documentFilter]),
-            ];
-        }
-        return super.for(context, overwriteProperties, overwriteContext);
-    }
-    /**
-     * Retrieves the collection name.
-     *
-     * @protected
-     * @returns The collection name.
-     * @throws {Error} If the collection name is not defined.
-     */
-    getCollectionName() {
-        const out = typeof this.collectionName === 'function'
-            ? this.collectionName(this)
-            : this.collectionName;
-        if (out)
-            return out;
-        throw new Error('collectionName is not defined');
-    }
-    /**
-     * Retrieves the resource name.
-     *
-     * @protected
-     * @returns {string} The resource name.
-     * @throws {Error} If the resource name is not defined.
-     */
-    getResourceName() {
-        const out = typeof this.resourceName === 'function'
-            ? this.resourceName(this)
-            : this.resourceName || this.getCollectionName();
-        if (out)
-            return out;
-        throw new Error('resourceName is not defined');
-    }
-    /**
-     * Retrieves the OPRA data type
-     *
-     * @throws {NotAcceptableError} If the data type is not a ComplexType.
-     */
-    get dataType() {
-        if (this._dataType && this._dataTypeScope !== this.scope)
-            this._dataType = undefined;
-        if (!this._dataType)
-            this._dataType = this.context.__docNode.getComplexType(this._dataType_);
-        this._dataTypeScope = this.scope;
-        return this._dataType;
-    }
-    /**
-     * Executes the provided function within a transaction.
-     *
-     * @param callback - The function to be executed within the transaction.
-     * @param [options] - Optional options for the transaction.
-     */
-    async withTransaction(callback, options) {
-        const ctx = this.context;
-        let closeSessionOnFinish = false;
-        let transaction = ctx[transactionKey];
-        let session;
-        if (transaction) {
-            session = transaction.session;
-        }
-        else {
-            const db = this.getDatabase();
-            const client = db.client;
-            session = client.startSession();
-            closeSessionOnFinish = true;
-            transaction = {
-                db,
-                session,
-            };
-            ctx[transactionKey] = transaction;
-        }
-        const oldInTransaction = session.inTransaction();
-        try {
-            if (!oldInTransaction)
-                session.startTransaction(options);
-            const out = await callback(session, this);
-            if (!oldInTransaction && session.inTransaction())
-                await session.commitTransaction();
-            return out;
-        }
-        catch (e) {
-            if (!oldInTransaction && session.inTransaction())
-                await session.abortTransaction();
-            throw e;
-        }
-        finally {
-            delete ctx[transactionKey];
-            if (closeSessionOnFinish) {
-                await session.endSession();
-            }
-        }
-    }
-    /**
-     * Retrieves the database connection.
-     *
-     * @protected
-     *
-     * @throws {Error} If the context or database is not set.
-     */
-    getDatabase() {
-        const ctx = this.context;
-        const transaction = ctx[transactionKey];
-        if (transaction)
-            return transaction.db;
-        const db = typeof this.db === 'function' ? this.db(this) : this.db;
-        if (db)
-            return db;
-        throw new Error(`Database not set!`);
-    }
-    /**
-     * Retrieves the database session.
-     *
-     * @protected
-     *
-     * @throws {Error} If the context or database is not set.
-     */
-    getSession() {
-        const ctx = this.context;
-        const transaction = ctx[transactionKey];
-        if (transaction)
-            return transaction.session;
-        const session = typeof this.session === 'function' ? this.session(this) : this.session;
-        if (session)
-            return session;
-    }
-    /**
-     * Retrieves a MongoDB collection from the given database.
-     *
-     * @param db - The MongoDB database.
-     * @protected
-     */
-    async getCollection(db) {
-        return db.collection(this.getCollectionName());
-    }
-    /**
-     * Generates an ID.
-     *
-     * @protected
-     * @returns {MongoAdapter.AnyId} The generated ID.
-     */
-    _generateId(command) {
-        return typeof this.idGenerator === 'function'
-            ? this.idGenerator(command, this)
-            : new mongodb_1.ObjectId();
-    }
-    /**
-     * 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.
-     */
-    _getDocumentFilter(command) {
-        const commonFilter = Array.isArray(this.documentFilter)
-            ? this.documentFilter
-            : [this.documentFilter];
-        const mapped = commonFilter.map(f => typeof f === 'function' ? f(command, this) : f);
-        return mapped.length > 1 ? mongo_adapter_js_1.MongoAdapter.prepareFilter(mapped) : mapped[0];
-    }
-    async _executeCommand(command, commandFn) {
-        let proto;
-        const next = async () => {
-            proto = proto ? Object.getPrototypeOf(proto) : this;
-            while (proto) {
-                if (proto.interceptor &&
-                    Object.prototype.hasOwnProperty.call(proto, 'interceptor')) {
-                    return await proto.interceptor.call(this, next, command, this);
-                }
-                proto = Object.getPrototypeOf(proto);
-                if (!(proto instanceof MongoService))
-                    break;
-            }
-            return commandFn();
-        };
-        try {
-            return await next();
-        }
-        catch (e) {
-            Error.captureStackTrace(e, this._executeCommand);
-            await this.onError?.(e, this);
-            throw e;
-        }
-    }
-    /**
-     * Retrieves the codec for the specified operation.
-     *
-     * @param operation - The operation to retrieve the encoder for. Valid values are 'create' and 'update'.
-     */
-    _getInputCodec(operation) {
-        const dataType = this.dataType;
-        const cacheKey = operation + (this._dataTypeScope ? ':' + this._dataTypeScope : '');
-        let validator = this._inputCodecs[cacheKey];
-        if (validator)
-            return validator;
-        const options = {
-            projection: '*',
-            scope: this._dataTypeScope,
-        };
-        if (operation === 'update') {
-            options.partial = 'deep';
-            options.allowPatchOperators = true;
-            options.keepKeyFields = true;
-        }
-        validator = dataType.generateCodec('decode', options);
-        this._inputCodecs[cacheKey] = validator;
-        return validator;
-    }
-    /**
-     * Retrieves the codec.
-     */
-    _getOutputCodec(operation) {
-        const cacheKey = operation + (this._dataTypeScope ? ':' + this._dataTypeScope : '');
-        let validator = this._outputCodecs[cacheKey];
-        if (validator)
-            return validator;
-        const options = {
-            projection: '*',
-            partial: 'deep',
-            scope: this._dataTypeScope,
-        };
-        const dataType = this.dataType;
-        validator = dataType.generateCodec('decode', options);
-        this._outputCodecs[cacheKey] = validator;
-        return validator;
-    }
-}
-exports.MongoService = MongoService;

package/cjs/services/mongo-singleton-service.js

@@ -1,213 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MongoSingletonService = void 0;
-const objects_1 = require("@jsopen/objects");
-const common_1 = require("@opra/common");
-const mongodb_1 = require("mongodb");
-const mongo_adapter_js_1 = require("../adapter/mongo-adapter.js");
-const mongo_entity_service_js_1 = require("./mongo-entity-service.js");
-/**
- * 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
- */
-class MongoSingletonService extends mongo_entity_service_js_1.MongoEntityService {
-    /**
-     * 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, options) {
-        super(dataType, options);
-        this._id = options?._id || new mongodb_1.ObjectId('655608925cad472b75fc6485');
-    }
-    /**
-     * Asserts the existence of a resource based on the given 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.
-     */
-    async assert(options) {
-        if (!(await this.exists(options)))
-            throw new common_1.ResourceNotAvailableError(this.getResourceName());
-    }
-    async create(input, options) {
-        const command = {
-            crud: 'create',
-            method: 'create',
-            byId: false,
-            input,
-            options,
-        };
-        input._id = this._id;
-        return this._executeCommand(command, async () => {
-            const r = await this._create(command);
-            if (!command.options?.projection)
-                return r;
-            const findCommand = {
-                ...command,
-                crud: 'read',
-                byId: true,
-                documentId: r._id,
-                options,
-            };
-            const out = await this._findById(findCommand);
-            if (out)
-                return out;
-        });
-    }
-    /**
-     * Creates the document in the database.
-     *
-     * @param {PartialDTO<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.
-     */
-    async createOnly(input, options) {
-        const command = {
-            crud: 'create',
-            method: 'createOnly',
-            byId: false,
-            input,
-            options,
-        };
-        input._id = this._id;
-        return this._executeCommand(command, () => this._create(command));
-    }
-    /**
-     * Deletes a record from the database
-     *
-     * @param {MongoEntityService.DeleteOptions<T>} options - The options for deleting the record
-     * @returns {Promise<number>} The number of records deleted
-     */
-    async delete(options) {
-        const command = {
-            crud: 'delete',
-            method: 'delete',
-            byId: true,
-            documentId: this._id,
-            options,
-        };
-        return this._executeCommand(command, async () => {
-            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
-                await this._getDocumentFilter(command),
-                command.options?.filter,
-            ]);
-            command.options = { ...command.options, filter };
-            return this._delete(command);
-        });
-    }
-    /**
-     * 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.
-     */
-    async exists(options) {
-        const command = {
-            crud: 'read',
-            method: 'exists',
-            byId: true,
-            documentId: this._id,
-            options,
-        };
-        return this._executeCommand(command, async () => {
-            const documentFilter = await this._getDocumentFilter(command);
-            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
-                documentFilter,
-                command.options?.filter,
-            ]);
-            const findCommand = command;
-            findCommand.options = { ...command.options, filter, projection: ['_id'] };
-            return !!(await this._findById(findCommand));
-        });
-    }
-    async find(options) {
-        const command = {
-            crud: 'read',
-            method: 'findById',
-            byId: true,
-            documentId: this._id,
-            options,
-        };
-        return this._executeCommand(command, async () => {
-            const documentFilter = await this._getDocumentFilter(command);
-            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
-                documentFilter,
-                command.options?.filter,
-            ]);
-            command.options = { ...command.options, filter };
-            return this._findById(command);
-        });
-    }
-    async get(options) {
-        const out = await this.find(options);
-        if (!out)
-            throw new common_1.ResourceNotAvailableError(this.getResourceName());
-        return out;
-    }
-    async update(input, options) {
-        const isUpdateFilter = Array.isArray(input) || !!Object.keys(input).find(x => x.startsWith('$'));
-        const command = {
-            crud: 'update',
-            method: 'update',
-            documentId: this._id,
-            byId: true,
-            input: isUpdateFilter ? undefined : input,
-            inputRaw: isUpdateFilter ? input : undefined,
-            options,
-        };
-        return this._executeCommand(command, async () => {
-            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
-                await this._getDocumentFilter(command),
-                command.options?.filter,
-            ]);
-            command.options = { ...command.options, filter };
-            const matchCount = await this._updateOnly(command);
-            if (matchCount) {
-                const findCommand = {
-                    ...command,
-                    crud: 'read',
-                    byId: true,
-                    documentId: this._id,
-                    options: (0, objects_1.omit)(options, ['filter', 'sort']),
-                };
-                const out = await this._findById(findCommand);
-                if (out)
-                    return out;
-            }
-        });
-    }
-    /**
-     * Updates a document in the MongoDB collection
-     *
-     * @param {MongoPatchDTO<T>} input - The partial input to update the document.
-     * @param {MongoEntityService.UpdateOneOptions<T>} [options] - The update options.
-     *
-     * @return {Promise<number>} - A promise that resolves to the updated document or undefined if not found.
-     */
-    async updateOnly(input, options) {
-        const command = {
-            crud: 'update',
-            method: 'updateOnly',
-            documentId: this._id,
-            byId: true,
-            input,
-            options,
-        };
-        return this._executeCommand(command, async () => {
-            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
-                await this._getDocumentFilter(command),
-                command.options?.filter,
-            ]);
-            command.options = { ...command.options, filter };
-            return this._updateOnly(command);
-        });
-    }
-}
-exports.MongoSingletonService = MongoSingletonService;

package/cjs/types.js

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

package/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/types/index.d.cts

@@ -1,8 +0,0 @@
-export * from './adapter/mongo-adapter.js';
-export * from './adapter/mongo-patch-generator.js';
-export * from './services/mongo-collection-service.js';
-export * from './services/mongo-entity-service.js';
-export * from './services/mongo-nested-service.js';
-export * from './services/mongo-service.js';
-export * from './services/mongo-singleton-service.js';
-export * from './types.js';