@opra/mongodb 1.21.0 → 1.22.1

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

@@ -1,578 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MongoEntityService = void 0;
-const objects_1 = require("@jsopen/objects");
-const common_1 = require("@opra/common");
-const valgen_1 = require("valgen");
-const mongo_adapter_js_1 = require("../adapter/mongo-adapter.js");
-const mongo_patch_generator_js_1 = require("../adapter/mongo-patch-generator.js");
-const mongo_service_js_1 = require("./mongo-service.js");
-/**
- * @class MongoEntityService
- * @template T - The type of the documents in the collection
- */
-class MongoEntityService extends mongo_service_js_1.MongoService {
-    /**
-     * Constructs a new instance
-     *
-     * @param {Type | string} dataType - The data type of the array elements.
-     * @param {MongoEntityService.Options} [options] - The options for the array service.
-     * @constructor
-     */
-    constructor(dataType, options) {
-        super(dataType, options);
-    }
-    /**
-     * Creates a new document in the MongoDB collection
-     *
-     * @param {MongoEntityService.CreateCommand} command
-     * @protected
-     */
-    async _create(command) {
-        const input = command.input;
-        (0, valgen_1.isNotNullish)(input, { label: 'input' });
-        (0, valgen_1.isNotNullish)(input._id, { label: 'input._id' });
-        const inputCodec = this._getInputCodec('create');
-        const document = inputCodec(input);
-        const { options } = command;
-        const db = this.getDatabase();
-        const collection = await this.getCollection(db);
-        const r = await collection.insertOne(document, {
-            ...options,
-            session: options?.session ?? this.getSession(),
-        });
-        /* istanbul ignore next */
-        if (!r.insertedId) {
-            throw new common_1.InternalServerError(`Unknown error while creating document for "${this.getResourceName()}"`);
-        }
-        return document;
-    }
-    /**
-     * Returns the count of documents in the collection based on the provided options.
-     *
-     * @param {MongoEntityService.CountCommand<T>} command
-     * @protected
-     */
-    async _count(command) {
-        const { options } = command;
-        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter(options?.filter);
-        const db = this.getDatabase();
-        const collection = await this.getCollection(db);
-        return ((await collection.countDocuments(filter || {}, {
-            ...options,
-            limit: undefined,
-            session: options?.session ?? this.getSession(),
-        })) || 0);
-    }
-    /**
-     * Deletes a document from the collection
-     *
-     * @param {MongoEntityService.DeleteCommand<T>} command
-     * @protected
-     */
-    async _delete(command) {
-        (0, valgen_1.isNotNullish)(command.documentId, { label: 'documentId' });
-        const { options } = command;
-        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
-            mongo_adapter_js_1.MongoAdapter.prepareKeyValues(command.documentId, ['_id']),
-            options?.filter,
-        ]);
-        const db = this.getDatabase();
-        const collection = await this.getCollection(db);
-        const session = options?.session ?? this.getSession();
-        return (await collection.deleteOne(filter || {}, {
-            ...options,
-            session,
-        })).deletedCount;
-    }
-    /**
-     * Deletes multiple documents from the collection that meet the specified filter criteria.
-     *
-     * @param {MongoEntityService.DeleteCommand<T>} command
-     * @protected
-     */
-    async _deleteMany(command) {
-        const { options } = command;
-        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter(options?.filter);
-        const db = this.getDatabase();
-        const collection = await this.getCollection(db);
-        return (await collection.deleteMany(filter || {}, {
-            ...options,
-            session: options?.session ?? this.getSession(),
-        })).deletedCount;
-    }
-    /**
-     * The distinct command returns a list of distinct values for the given key across a collection
-     *
-     * @param {MongoEntityService.DistinctCommand<T>} command
-     * @protected
-     */
-    async _distinct(command) {
-        const { options, field } = command;
-        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter(options?.filter);
-        const db = this.getDatabase();
-        const collection = await this.getCollection(db);
-        return await collection.distinct(field, filter || {}, {
-            ...options,
-            session: options?.session ?? this.getSession(),
-        });
-    }
-    /**
-     * Finds a document by its ID.
-     *
-     * @param { MongoEntityService.FindOneCommand<T>} command
-     */
-    async _findById(command) {
-        (0, valgen_1.isNotNullish)(command.documentId, { label: 'documentId' });
-        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
-            mongo_adapter_js_1.MongoAdapter.prepareKeyValues(command.documentId, ['_id']),
-            command.options?.filter,
-        ]);
-        const { options } = command;
-        const findManyCommand = {
-            ...command,
-            options: {
-                ...options,
-                filter,
-                limit: 1,
-                skip: undefined,
-            },
-        };
-        const rows = await this._findMany(findManyCommand);
-        return rows?.[0];
-    }
-    /**
-     * Finds a document in the collection that matches the specified options.
-     *
-     * @param {MongoEntityService.FindOneCommand<T>} command
-     */
-    async _findOne(command) {
-        const { options } = command;
-        const findManyCommand = {
-            ...command,
-            options: {
-                ...options,
-                limit: 1,
-            },
-        };
-        const rows = await this._findMany(findManyCommand);
-        return rows?.[0];
-    }
-    /**
-     * Finds multiple documents in the MongoDB collection
-     *
-     * @param {MongoEntityService.FindManyCommand<T>} command
-     */
-    async _findMany(command) {
-        const { options } = command;
-        const stages = [];
-        /** Pre-Stages */
-        if (options?.preStages)
-            stages.push(...options.preStages);
-        /** "Filter" stage */
-        let filter;
-        if (options?.filter)
-            filter = mongo_adapter_js_1.MongoAdapter.prepareFilter(options?.filter);
-        if (filter)
-            stages.push({ $match: filter });
-        /** "Skip" stage */
-        if (options?.skip)
-            stages.push({ $skip: options.skip });
-        /** "Sort" stage */
-        if (options?.sort) {
-            const sort = mongo_adapter_js_1.MongoAdapter.prepareSort(options.sort);
-            if (sort)
-                stages.push({ $sort: sort });
-        }
-        /** "Limit" stage */
-        stages.push({ $limit: options?.limit || 10 });
-        /** Post-Stages */
-        if (options?.postStages)
-            stages.push(...options.postStages);
-        const dataType = this.dataType;
-        const projection = mongo_adapter_js_1.MongoAdapter.prepareProjection(dataType, options?.projection, this._dataTypeScope);
-        if (projection)
-            stages.push({ $project: projection });
-        const db = this.getDatabase();
-        const collection = await this.getCollection(db);
-        const cursor = collection.aggregate(stages, {
-            ...(0, objects_1.omit)(options, ['projection', 'sort', 'skip', 'limit', 'filter']),
-            session: options?.session ?? this.getSession(),
-        });
-        /** Execute db command */
-        try {
-            /** Fetch the cursor */
-            if (options?.noDecode)
-                return cursor.toArray();
-            /** Decode result objects */
-            const outputCodec = this._getOutputCodec('find');
-            return (await cursor.toArray()).map((r) => outputCodec(r));
-        }
-        finally {
-            if (!cursor.closed)
-                await cursor.close();
-        }
-    }
-    /**
-     * Finds multiple documents in the collection and returns both records (max limit)
-     * and total count that matched the given criteria
-     *
-     * @param {MongoEntityService.FindManyCommand<T>} command
-     */
-    async _findManyWithCount(command) {
-        const { options } = command;
-        const limit = options?.limit || 10;
-        let filter;
-        if (options?.filter)
-            filter = mongo_adapter_js_1.MongoAdapter.prepareFilter(options?.filter);
-        const dataStages = [];
-        const countStages = [];
-        const stages = [
-            {
-                $facet: {
-                    data: dataStages,
-                    count: countStages,
-                },
-            },
-        ];
-        /** Pre-Stages */
-        if (options?.preStages)
-            dataStages.push(...options.preStages);
-        /** Filter */
-        if (filter) {
-            countStages.push({ $match: filter });
-            dataStages.push({ $match: filter });
-        }
-        countStages.push({ $count: 'totalMatches' });
-        /** Sort */
-        if (options?.sort) {
-            const sort = mongo_adapter_js_1.MongoAdapter.prepareSort(options.sort);
-            if (sort)
-                dataStages.push({ $sort: sort });
-        }
-        /** Skip */
-        if (options?.skip)
-            dataStages.push({ $skip: options.skip });
-        /** Limit */
-        dataStages.push({ $limit: limit });
-        const dataType = this.dataType;
-        const projection = mongo_adapter_js_1.MongoAdapter.prepareProjection(dataType, options?.projection, this._dataTypeScope);
-        if (projection)
-            dataStages.push({ $project: projection });
-        const outputCodec = this._getOutputCodec('find');
-        /** Execute db command */
-        const db = this.getDatabase();
-        const collection = await this.getCollection(db);
-        const cursor = collection.aggregate(stages, {
-            ...(0, objects_1.omit)(options, ['projection', 'sort', 'skip', 'limit', 'filter']),
-            session: options?.session ?? this.getSession(),
-        });
-        /** Fetch the cursor and decode the result objects */
-        try {
-            const facetResult = await cursor.toArray();
-            return {
-                count: facetResult[0].count[0]?.totalMatches || 0,
-                items: options?.noDecode
-                    ? facetResult[0].data
-                    : facetResult[0].data?.map((r) => outputCodec(r)),
-            };
-        }
-        finally {
-            if (!cursor.closed)
-                await cursor.close();
-        }
-    }
-    /**
-     * Updates a document with the given id in the collection
-     *
-     * @param {MongoEntityService.UpdateOneCommand<T>} command
-     */
-    async _update(command) {
-        (0, valgen_1.isNotNullish)(command.documentId, { label: 'documentId' });
-        const { input, inputRaw } = command;
-        (0, valgen_1.isNotNullish)(input || inputRaw, { label: 'input' });
-        if (input && inputRaw) {
-            throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
-        }
-        const update = this._prepareUpdate(command);
-        const options = command.options;
-        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
-            mongo_adapter_js_1.MongoAdapter.prepareKeyValues(command.documentId, ['_id']),
-            options?.filter,
-        ]);
-        const db = this.getDatabase();
-        const collection = await this.getCollection(db);
-        const out = await collection.findOneAndUpdate(filter || {}, update, {
-            upsert: undefined,
-            ...options,
-            returnDocument: 'after',
-            includeResultMetadata: false,
-            session: options?.session ?? this.getSession(),
-            projection: mongo_adapter_js_1.MongoAdapter.prepareProjection(this.dataType, options?.projection, this._dataTypeScope),
-        });
-        const outputCodec = this._getOutputCodec('update');
-        if (out)
-            return outputCodec(out);
-    }
-    /**
-     * Updates a document in the collection with the specified ID.
-     *
-     * @param {MongoEntityService.UpdateOneCommand<T>} command
-     */
-    async _updateOnly(command) {
-        (0, valgen_1.isNotNullish)(command.documentId, { label: 'documentId' });
-        const { input, inputRaw } = command;
-        (0, valgen_1.isNotNullish)(input || inputRaw, { label: 'input' });
-        if (input && inputRaw) {
-            throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
-        }
-        const update = this._prepareUpdate(command);
-        const options = command.options;
-        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
-            mongo_adapter_js_1.MongoAdapter.prepareKeyValues(command.documentId, ['_id']),
-            options?.filter,
-        ]);
-        const db = this.getDatabase();
-        const collection = await this.getCollection(db);
-        /** Create array fields if not exists */
-        if (options?.initArrayFields) {
-            const $set = options.initArrayFields.reduce((a, k) => {
-                a[k] = { $ifNull: ['$' + k, []] };
-                return a;
-            }, {});
-            await collection.updateOne(filter || {}, [{ $set }], {
-                ...options,
-                session: options?.session ?? this.getSession(),
-                arrayFilters: undefined,
-                upsert: false,
-            });
-            delete options.initArrayFields;
-        }
-        /** Execute update operation */
-        return (await collection.updateOne(filter || {}, update, {
-            ...options,
-            session: options?.session ?? this.getSession(),
-            upsert: undefined,
-        })).matchedCount;
-    }
-    /**
-     * Updates multiple documents in the collection based on the specified input and options.
-     *
-     * @param {MongoEntityService.UpdateManyCommand<T>} command
-     */
-    async _updateMany(command) {
-        (0, valgen_1.isNotNullish)(command.input, { label: 'input' });
-        const { input, inputRaw } = command;
-        (0, valgen_1.isNotNullish)(input || inputRaw, { label: 'input' });
-        if (input && inputRaw) {
-            throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
-        }
-        const update = this._prepareUpdate(command);
-        const options = command.options;
-        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter(options?.filter);
-        const db = this.getDatabase();
-        const collection = await this.getCollection(db);
-        /** Create array fields if not exists */
-        if (options?.initArrayFields) {
-            const $set = options.initArrayFields.reduce((a, k) => {
-                a[k] = { $ifNull: ['$' + k, []] };
-                return a;
-            }, {});
-            await collection.updateMany(filter || {}, [{ $set }], {
-                ...(0, objects_1.omit)(options, ['filter']),
-                session: options?.session ?? this.getSession(),
-                arrayFilters: undefined,
-                upsert: false,
-            });
-            delete options.initArrayFields;
-        }
-        /** Execute update operation */
-        return (await collection.updateMany(filter || {}, update, {
-            ...(0, objects_1.omit)(options, ['filter']),
-            session: options?.session ?? this.getSession(),
-            upsert: false,
-        })).matchedCount;
-    }
-    /**
-     * Replaces a document with the given id in the collection
-     *
-     * @param {MongoEntityService.ReplaceCommand<T>} command
-     */
-    async _replace(command) {
-        const input = command.input;
-        (0, valgen_1.isNotNullish)(input, { label: 'input' });
-        (0, valgen_1.isNotNullish)(input._id, { label: 'input._id' });
-        const inputCodec = this._getInputCodec('replace');
-        const document = inputCodec(input);
-        const { options } = command;
-        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
-            mongo_adapter_js_1.MongoAdapter.prepareKeyValues(command.documentId, ['_id']),
-            options?.filter,
-        ]);
-        const db = this.getDatabase();
-        const collection = await this.getCollection(db);
-        const out = await collection.findOneAndReplace(filter || {}, document, {
-            upsert: undefined,
-            ...options,
-            returnDocument: 'after',
-            includeResultMetadata: false,
-            session: options?.session ?? this.getSession(),
-            projection: mongo_adapter_js_1.MongoAdapter.prepareProjection(this.dataType, options?.projection, this._dataTypeScope),
-        });
-        const outputCodec = this._getOutputCodec('replace');
-        if (out)
-            return outputCodec(out);
-    }
-    _prepareUpdate(command) {
-        const { input, inputRaw } = command;
-        (0, valgen_1.isNotNullish)(input || inputRaw, { label: 'input' });
-        if (input && inputRaw) {
-            throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
-        }
-        if (inputRaw)
-            return inputRaw;
-        const inputCodec = this._getInputCodec('update');
-        const doc = inputCodec(input);
-        delete doc._id;
-        if (doc._$push) {
-            doc._$push = inputCodec(doc._$push);
-        }
-        return this._generatePatch(command, doc);
-    }
-    _generatePatch(command, doc) {
-        const patchGenerator = new mongo_patch_generator_js_1.MongoPatchGenerator();
-        const { update, arrayFilters, initArrayFields } = patchGenerator.generatePatch(this.dataType, doc, {
-            scope: this._dataTypeScope,
-        });
-        command.options = command.options || {};
-        if (arrayFilters) {
-            command.options.arrayFilters = command.options.arrayFilters || [];
-            command.options.arrayFilters.push(...arrayFilters);
-            command.options.initArrayFields = initArrayFields;
-        }
-        return update;
-    }
-    async _executeCommand(command, commandFn) {
-        try {
-            const result = await super._executeCommand(command, async () => {
-                /** Call before[X] hooks */
-                if (command.crud === 'create')
-                    await this._beforeCreate(command);
-                else if (command.crud === 'delete' && command.byId) {
-                    await this._beforeDelete(command);
-                }
-                else if (command.crud === 'delete' && !command.byId) {
-                    await this._beforeDeleteMany(command);
-                }
-                else if (command.crud === 'replace') {
-                    await this._beforeReplace(command);
-                }
-                else if (command.crud === 'update' && command.byId) {
-                    await this._beforeUpdate(command);
-                }
-                else if (command.crud === 'update' && !command.byId) {
-                    await this._beforeUpdateMany(command);
-                }
-                /** Call command function */
-                return commandFn();
-            });
-            /** Call after[X] hooks */
-            if (command.crud === 'create')
-                await this._afterCreate(command, result);
-            else if (command.crud === 'delete' && command.byId) {
-                await this._afterDelete(command, result);
-            }
-            else if (command.crud === 'delete' && !command.byId) {
-                await this._afterDeleteMany(command, result);
-            }
-            else if (command.crud === 'replace') {
-                await this._afterReplace(command, result);
-            }
-            else if (command.crud === 'update' && command.byId) {
-                await this._afterUpdate(command, result);
-            }
-            else if (command.crud === 'update' && !command.byId) {
-                await this._afterUpdateMany(command, result);
-            }
-            return result;
-        }
-        catch (e) {
-            Error.captureStackTrace(e, this._executeCommand);
-            await this.onError?.(e, this);
-            throw e;
-        }
-    }
-    async _beforeCreate(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command) {
-        // Do nothing
-    }
-    async _beforeDelete(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command) {
-        // Do nothing
-    }
-    async _beforeDeleteMany(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command) {
-        // Do nothing
-    }
-    async _beforeReplace(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command) {
-        // Do nothing
-    }
-    async _beforeUpdate(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command) {
-        // Do nothing
-    }
-    async _beforeUpdateMany(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command) {
-        // Do nothing
-    }
-    async _afterCreate(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    result) {
-        // Do nothing
-    }
-    async _afterReplace(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    result) {
-        // Do nothing
-    }
-    async _afterDelete(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    affected) {
-        // Do nothing
-    }
-    async _afterDeleteMany(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    affected) {
-        // Do nothing
-    }
-    async _afterUpdate(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    result) {
-        // Do nothing
-    }
-    async _afterUpdateMany(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    command, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    affected) {
-        // Do nothing
-    }
-}
-exports.MongoEntityService = MongoEntityService;