@ptc-org/nestjs-query-mongoose 1.0.0-alpha.1 → 1.1.0

package/src/query/filter-query.builder.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterQueryBuilder = void 0;
+const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
+const aggregate_builder_1 = require("./aggregate.builder");
+const helpers_1 = require("./helpers");
+const where_builder_1 = require("./where.builder");
+const MONGOOSE_SORT_DIRECTION = {
+    [nestjs_query_core_1.SortDirection.ASC]: 1,
+    [nestjs_query_core_1.SortDirection.DESC]: -1
+};
+/**
+ * @internal
+ *
+ * Class that will convert a Query into a `typeorm` Query Builder.
+ */
+class FilterQueryBuilder {
+    constructor(Model, whereBuilder = new where_builder_1.WhereBuilder(Model), aggregateBuilder = new aggregate_builder_1.AggregateBuilder()) {
+        this.Model = Model;
+        this.whereBuilder = whereBuilder;
+        this.aggregateBuilder = aggregateBuilder;
+    }
+    buildQuery({ filter, paging, sorting }) {
+        return {
+            filterQuery: this.buildFilterQuery(filter),
+            options: { limit: paging?.limit, skip: paging?.offset, sort: this.buildSorting(sorting) }
+        };
+    }
+    buildAggregateQuery(aggregate, filter) {
+        return {
+            filterQuery: this.buildFilterQuery(filter),
+            aggregate: this.aggregateBuilder.build(aggregate),
+            options: { sort: this.buildAggregateSorting(aggregate) }
+        };
+    }
+    buildIdAggregateQuery(id, filter, aggregate) {
+        return {
+            filterQuery: this.buildIdFilterQuery(id, filter),
+            aggregate: this.aggregateBuilder.build(aggregate),
+            options: { sort: this.buildAggregateSorting(aggregate) }
+        };
+    }
+    buildIdFilterQuery(id, filter) {
+        return {
+            ...this.buildFilterQuery(filter),
+            _id: Array.isArray(id) ? { $in: id } : id
+        };
+    }
+    /**
+     * Applies the filter from a Query to a `typeorm` QueryBuilder.
+     *
+     * @param filter - the filter.
+     */
+    buildFilterQuery(filter) {
+        if (!filter) {
+            return {};
+        }
+        return this.whereBuilder.build(filter);
+    }
+    /**
+     * Applies the ORDER BY clause to a `typeorm` QueryBuilder.
+     * @param sorts - an array of SortFields to create the ORDER BY clause.
+     */
+    buildSorting(sorts) {
+        if (!sorts) {
+            return undefined;
+        }
+        return sorts.reduce((sort, sortField) => {
+            const field = (0, helpers_1.getSchemaKey)(sortField.field.toString());
+            const direction = MONGOOSE_SORT_DIRECTION[sortField.direction];
+            return { ...sort, [field]: direction };
+        }, {});
+    }
+    buildAggregateSorting(aggregate) {
+        const aggregateGroupBy = this.aggregateBuilder.getGroupBySelects(aggregate.groupBy);
+        if (!aggregateGroupBy) {
+            return undefined;
+        }
+        return aggregateGroupBy.reduce((sort, sortField) => {
+            return { ...sort, [(0, helpers_1.getSchemaKey)(sortField)]: MONGOOSE_SORT_DIRECTION[nestjs_query_core_1.SortDirection.ASC] };
+        }, {});
+    }
+}
+exports.FilterQueryBuilder = FilterQueryBuilder;
+//# sourceMappingURL=filter-query.builder.js.map

package/src/query/filter-query.builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-query.builder.js","sourceRoot":"","sources":["../../../../../packages/query-mongoose/src/query/filter-query.builder.ts"],"names":[],"mappings":";;;AAAA,kEAAoG;AAGpG,2DAAiF;AACjF,uCAAwC;AACxC,mDAA8C;AAE9C,MAAM,uBAAuB,GAAkC;IAC7D,CAAC,iCAAa,CAAC,GAAG,CAAC,EAAE,CAAC;IACtB,CAAC,iCAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;CACzB,CAAA;AAYD;;;;GAIG;AACH,MAAa,kBAAkB;IAC7B,YACW,KAA4B,EAC5B,eAAqC,IAAI,4BAAY,CAAS,KAAK,CAAC,EACpE,mBAA6C,IAAI,oCAAgB,EAAU;QAF3E,UAAK,GAAL,KAAK,CAAuB;QAC5B,iBAAY,GAAZ,YAAY,CAAwD;QACpE,qBAAgB,GAAhB,gBAAgB,CAA2D;IACnF,CAAC;IAEJ,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAiB;QACnD,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;YAC1C,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE;SAC1F,CAAA;IACH,CAAC;IAED,mBAAmB,CAAC,SAAiC,EAAE,MAAuB;QAC5E,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;YAC1C,SAAS,EAAE,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,CAAC;YACjD,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,EAAE;SACzD,CAAA;IACH,CAAC;IAED,qBAAqB,CACnB,EAAuB,EACvB,MAAsB,EACtB,SAAiC;QAEjC,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,MAAM,CAAC;YAChD,SAAS,EAAE,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,CAAC;YACjD,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,EAAE;SACzD,CAAA;IACH,CAAC;IAED,kBAAkB,CAAC,EAAuB,EAAE,MAAuB;QACjE,OAAO;YACL,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;YAChC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE;SAC1C,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAAuB;QACtC,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,EAAE,CAAA;SACV;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IACxC,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,KAA2B;QACtC,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,SAAS,CAAA;SACjB;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAkB,EAAE,SAA4B,EAAE,EAAE;YACvE,MAAM,KAAK,GAAG,IAAA,sBAAY,EAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;YACtD,MAAM,SAAS,GAAG,uBAAuB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;YAC9D,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAA;QACxC,CAAC,EAAE,EAAE,CAAC,CAAA;IACR,CAAC;IAEO,qBAAqB,CAAC,SAAiC;QAC7D,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QACnF,IAAI,CAAC,gBAAgB,EAAE;YACrB,OAAO,SAAS,CAAA;SACjB;QACD,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC,IAAkB,EAAE,SAAS,EAAE,EAAE;YAC/D,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,IAAA,sBAAY,EAAC,SAAS,CAAC,CAAC,EAAE,uBAAuB,CAAC,iCAAa,CAAC,GAAG,CAAC,EAAE,CAAA;QAC3F,CAAC,EAAE,EAAE,CAAC,CAAA;IACR,CAAC;CACF;AA7ED,gDA6EC"}

package/src/query/helpers.d.ts

@@ -0,0 +1 @@
+export declare function getSchemaKey(key: string): string;

package/src/query/helpers.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSchemaKey = void 0;
+function getSchemaKey(key) {
+    return key === 'id' ? '_id' : key;
+}
+exports.getSchemaKey = getSchemaKey;
+//# sourceMappingURL=helpers.js.map

package/src/query/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../../../packages/query-mongoose/src/query/helpers.ts"],"names":[],"mappings":";;;AAAA,SAAgB,YAAY,CAAC,GAAW;IACtC,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAA;AACnC,CAAC;AAFD,oCAEC"}

package/src/query/index.d.ts

@@ -0,0 +1,4 @@
+export * from './aggregate.builder';
+export * from './comparison.builder';
+export * from './filter-query.builder';
+export * from './where.builder';

package/src/query/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./aggregate.builder"), exports);
+(0, tslib_1.__exportStar)(require("./comparison.builder"), exports);
+(0, tslib_1.__exportStar)(require("./filter-query.builder"), exports);
+(0, tslib_1.__exportStar)(require("./where.builder"), exports);
+//# sourceMappingURL=index.js.map

package/src/query/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/query-mongoose/src/query/index.ts"],"names":[],"mappings":";;;AAAA,mEAAmC;AACnC,oEAAoC;AACpC,sEAAsC;AACtC,+DAA+B"}

package/src/query/where.builder.d.ts

@@ -0,0 +1,24 @@
+import { Filter } from '@ptc-org/nestjs-query-core';
+import { Document, FilterQuery, Model as MongooseModel } from 'mongoose';
+import { ComparisonBuilder } from './comparison.builder';
+/**
+ * @internal
+ * Builds a WHERE clause from a Filter.
+ */
+export declare class WhereBuilder<Entity extends Document> {
+    readonly Model: MongooseModel<Entity>;
+    readonly comparisonBuilder: ComparisonBuilder<Entity>;
+    constructor(Model: MongooseModel<Entity>, comparisonBuilder?: ComparisonBuilder<Entity>);
+    /**
+     * Builds a WHERE clause from a Filter.
+     * @param filter - the filter to build the WHERE clause from.
+     */
+    build(filter: Filter<Entity>): FilterQuery<Entity>;
+    /**
+     * Creates field comparisons from a filter. This method will ignore and/or properties.
+     * @param filter - the filter with fields to create comparisons for.
+     */
+    private filterFields;
+    private getField;
+    private withFilterComparison;
+}

package/src/query/where.builder.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhereBuilder = void 0;
+const comparison_builder_1 = require("./comparison.builder");
+/**
+ * @internal
+ * Builds a WHERE clause from a Filter.
+ */
+class WhereBuilder {
+    constructor(Model, comparisonBuilder = new comparison_builder_1.ComparisonBuilder(Model)) {
+        this.Model = Model;
+        this.comparisonBuilder = comparisonBuilder;
+    }
+    /**
+     * Builds a WHERE clause from a Filter.
+     * @param filter - the filter to build the WHERE clause from.
+     */
+    build(filter) {
+        const { and, or } = filter;
+        let ands = [];
+        let ors = [];
+        let filterQuery = {};
+        if (and && and.length) {
+            ands = and.map((f) => this.build(f));
+        }
+        if (or && or.length) {
+            ors = or.map((f) => this.build(f));
+        }
+        const filterAnds = this.filterFields(filter);
+        if (filterAnds) {
+            ands = [...ands, filterAnds];
+        }
+        if (ands.length) {
+            filterQuery = { ...filterQuery, $and: ands };
+        }
+        if (ors.length) {
+            filterQuery = { ...filterQuery, $or: ors };
+        }
+        return filterQuery;
+    }
+    /**
+     * Creates field comparisons from a filter. This method will ignore and/or properties.
+     * @param filter - the filter with fields to create comparisons for.
+     */
+    filterFields(filter) {
+        const ands = Object.keys(filter)
+            .filter((f) => f !== 'and' && f !== 'or')
+            .map((field) => this.withFilterComparison(field, this.getField(filter, field)));
+        if (ands.length === 1) {
+            return ands[0];
+        }
+        if (ands.length) {
+            return { $and: ands };
+        }
+        return undefined;
+    }
+    getField(obj, field) {
+        return obj[field];
+    }
+    withFilterComparison(field, cmp) {
+        const opts = Object.keys(cmp);
+        if (opts.length === 1) {
+            const cmpType = opts[0];
+            return this.comparisonBuilder.build(field, cmpType, cmp[cmpType]);
+        }
+        return {
+            $or: opts.map((cmpType) => this.comparisonBuilder.build(field, cmpType, cmp[cmpType]))
+        };
+    }
+}
+exports.WhereBuilder = WhereBuilder;
+//# sourceMappingURL=where.builder.js.map

package/src/query/where.builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"where.builder.js","sourceRoot":"","sources":["../../../../../packages/query-mongoose/src/query/where.builder.ts"],"names":[],"mappings":";;;AAGA,6DAA+E;AAE/E;;;GAGG;AACH,MAAa,YAAY;IACvB,YACW,KAA4B,EAC5B,oBAA+C,IAAI,sCAAiB,CAAC,KAAK,CAAC;QAD3E,UAAK,GAAL,KAAK,CAAuB;QAC5B,sBAAiB,GAAjB,iBAAiB,CAA0D;IACnF,CAAC;IAEJ;;;OAGG;IACH,KAAK,CAAC,MAAsB;QAC1B,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,MAAM,CAAA;QAC1B,IAAI,IAAI,GAA0B,EAAE,CAAA;QACpC,IAAI,GAAG,GAA0B,EAAE,CAAA;QACnC,IAAI,WAAW,GAAwB,EAAE,CAAA;QACzC,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE;YACrB,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;SACrC;QACD,IAAI,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE;YACnB,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;SACnC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAC5C,IAAI,UAAU,EAAE;YACd,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAA;SAC7B;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,WAAW,GAAG,EAAE,GAAG,WAAW,EAAE,IAAI,EAAE,IAAI,EAAyB,CAAA;SACpE;QACD,IAAI,GAAG,CAAC,MAAM,EAAE;YACd,WAAW,GAAG,EAAE,GAAG,WAAW,EAAE,GAAG,EAAE,GAAG,EAAyB,CAAA;SAClE;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;IAED;;;OAGG;IACK,YAAY,CAAC,MAAsB;QACzC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;aAC7B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,IAAI,CAAC;aACxC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAqB,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAqB,CAAC,CAAC,CAAC,CAAA;QACjH,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACrB,OAAO,IAAI,CAAC,CAAC,CAAC,CAAA;SACf;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,OAAO,EAAE,IAAI,EAAE,IAAI,EAAyB,CAAA;SAC7C;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAEO,QAAQ,CACd,GAA8B,EAC9B,KAAQ;QAER,OAAO,GAAG,CAAC,KAAK,CAAqC,CAAA;IACvD,CAAC;IAEO,oBAAoB,CAAyB,KAAQ,EAAE,GAAqC;QAClG,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAA+C,CAAA;QAC3E,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACrB,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;YACvB,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,CAAqC,CAAC,CAAA;SACtG;QACD,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,CAAqC,CAAC,CAAC;SACpG,CAAA;IAC1B,CAAC;CACF;AApED,oCAoEC"}

package/src/services/index.d.ts

@@ -0,0 +1 @@
+export * from './mongoose-query.service';

package/src/services/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./mongoose-query.service"), exports);
+//# sourceMappingURL=index.js.map

package/src/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/query-mongoose/src/services/index.ts"],"names":[],"mappings":";;;AAAA,wEAAwC"}

package/src/services/mongoose-query.service.d.ts

@@ -0,0 +1,145 @@
+import { AggregateQuery, AggregateResponse, DeepPartial, DeleteManyResponse, DeleteOneOptions, Filter, FindByIdOptions, GetByIdOptions, Query, QueryService, UpdateManyResponse, UpdateOneOptions } from '@ptc-org/nestjs-query-core';
+import { Document, Model as MongooseModel } from 'mongoose';
+import { FilterQueryBuilder } from '../query';
+import { ReferenceQueryService } from './reference-query.service';
+/**
+ * Base class for all query services that use Typegoose.
+ *
+ * @example
+ *
+ * ```ts
+ * @QueryService(TodoItemEntity)
+ * export class TodoItemService extends TypegooseQueryService<TodoItemEntity> {
+ *   constructor(
+ *     @InjectModel(TodoItemEntity) model: ReturnModelType<typeof TodoItemEntity>,
+ *   ) {
+ *     super(model);
+ *   }
+ * }
+ * ```
+ */
+export declare class MongooseQueryService<Entity extends Document> extends ReferenceQueryService<Entity> implements QueryService<Entity, DeepPartial<Entity>, DeepPartial<Entity>> {
+    readonly Model: MongooseModel<Entity>;
+    readonly filterQueryBuilder: FilterQueryBuilder<Entity>;
+    constructor(Model: MongooseModel<Entity>, filterQueryBuilder?: FilterQueryBuilder<Entity>);
+    /**
+     * Query for multiple entities, using a Query from `@ptc-org/nestjs-query-core`.
+     *
+     * @example
+     * ```ts
+     * const todoItems = await this.service.query({
+     *   filter: { title: { eq: 'Foo' } },
+     *   paging: { limit: 10 },
+     *   sorting: [{ field: "create", direction: SortDirection.DESC }],
+     * });
+     * ```
+     * @param query - The Query used to filter, page, and sort rows.
+     */
+    query(query: Query<Entity>): Promise<Entity[]>;
+    aggregate(filter: Filter<Entity>, aggregateQuery: AggregateQuery<Entity>): Promise<AggregateResponse<Entity>[]>;
+    count(filter: Filter<Entity>): Promise<number>;
+    /**
+     * Find an entity by it's `id`.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.findById(1);
+     * ```
+     * @param id - The id of the record to find.
+     * @param opts - Additional options
+     */
+    findById(id: string | number, opts?: FindByIdOptions<Entity>): Promise<Entity | undefined>;
+    /**
+     * Gets an entity by it's `id`. If the entity is not found a rejected promise is returned.
+     *
+     * @example
+     * ```ts
+     * try {
+     *   const todoItem = await this.service.getById(1);
+     * } catch(e) {
+     *   console.error('Unable to find entity with id = 1');
+     * }
+     * ```
+     * @param id - The id of the record to find.
+     * @param opts - Additional options
+     */
+    getById(id: string, opts?: GetByIdOptions<Entity>): Promise<Entity>;
+    /**
+     * Creates a single entity.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.createOne({title: 'Todo Item', completed: false });
+     * ```
+     * @param record - The entity to create.
+     */
+    createOne(record: DeepPartial<Entity>): Promise<Entity>;
+    /**
+     * Create multiple entities.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.createMany([
+     *   {title: 'Todo Item 1', completed: false },
+     *   {title: 'Todo Item 2', completed: true },
+     * ]);
+     * ```
+     * @param records - The entities to create.
+     */
+    createMany(records: DeepPartial<Entity>[]): Promise<Entity[]>;
+    /**
+     * Update an entity.
+     *
+     * @example
+     * ```ts
+     * const updatedEntity = await this.service.updateOne(1, { completed: true });
+     * ```
+     * @param id - The `id` of the record.
+     * @param update - A `Partial` of the entity with fields to update.
+     * @param opts - Additional options
+     */
+    updateOne(id: string, update: DeepPartial<Entity>, opts?: UpdateOneOptions<Entity>): Promise<Entity>;
+    /**
+     * Update multiple entities with a `@ptc-org/nestjs-query-core` Filter.
+     *
+     * @example
+     * ```ts
+     * const { updatedCount } = await this.service.updateMany(
+     *   { completed: true }, // the update to apply
+     *   { title: { eq: 'Foo Title' } } // Filter to find records to update
+     * );
+     * ```
+     * @param update - A `Partial` of entity with the fields to update
+     * @param filter - A Filter used to find the records to update
+     */
+    updateMany(update: DeepPartial<Entity>, filter: Filter<Entity>): Promise<UpdateManyResponse>;
+    /**
+     * Delete an entity by `id`.
+     *
+     * @example
+     *
+     * ```ts
+     * const deletedTodo = await this.service.deleteOne(1);
+     * ```
+     *
+     * @param id - The `id` of the entity to delete.
+     * @param opts - Additional filter to use when finding the entity to delete.
+     */
+    deleteOne(id: string, opts?: DeleteOneOptions<Entity>): Promise<Entity>;
+    /**
+     * Delete multiple records with a `@ptc-org/nestjs-query-core` `Filter`.
+     *
+     * @example
+     *
+     * ```ts
+     * const { deletedCount } = this.service.deleteMany({
+     *   created: { lte: new Date('2020-1-1') }
+     * });
+     * ```
+     *
+     * @param filter - A `Filter` to find records to delete.
+     */
+    deleteMany(filter: Filter<Entity>): Promise<DeleteManyResponse>;
+    private ensureIdIsNotPresent;
+    private getUpdateQuery;
+}

package/src/services/mongoose-query.service.js

@@ -0,0 +1,222 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MongooseQueryService = void 0;
+/* eslint-disable no-underscore-dangle */
+const common_1 = require("@nestjs/common");
+const query_1 = require("../query");
+const reference_query_service_1 = require("./reference-query.service");
+/**
+ * Base class for all query services that use Typegoose.
+ *
+ * @example
+ *
+ * ```ts
+ * @QueryService(TodoItemEntity)
+ * export class TodoItemService extends TypegooseQueryService<TodoItemEntity> {
+ *   constructor(
+ *     @InjectModel(TodoItemEntity) model: ReturnModelType<typeof TodoItemEntity>,
+ *   ) {
+ *     super(model);
+ *   }
+ * }
+ * ```
+ */
+class MongooseQueryService extends reference_query_service_1.ReferenceQueryService {
+    constructor(Model, filterQueryBuilder = new query_1.FilterQueryBuilder(Model)) {
+        super();
+        this.Model = Model;
+        this.filterQueryBuilder = filterQueryBuilder;
+    }
+    /**
+     * Query for multiple entities, using a Query from `@ptc-org/nestjs-query-core`.
+     *
+     * @example
+     * ```ts
+     * const todoItems = await this.service.query({
+     *   filter: { title: { eq: 'Foo' } },
+     *   paging: { limit: 10 },
+     *   sorting: [{ field: "create", direction: SortDirection.DESC }],
+     * });
+     * ```
+     * @param query - The Query used to filter, page, and sort rows.
+     */
+    async query(query) {
+        const { filterQuery, options } = this.filterQueryBuilder.buildQuery(query);
+        return this.Model.find(filterQuery, {}, options).exec();
+    }
+    async aggregate(filter, aggregateQuery) {
+        const { aggregate, filterQuery, options } = this.filterQueryBuilder.buildAggregateQuery(aggregateQuery, filter);
+        const aggPipeline = [{ $match: filterQuery }, { $group: aggregate }];
+        if (options.sort) {
+            aggPipeline.push({ $sort: options.sort ?? {} });
+        }
+        const aggResult = await this.Model.aggregate(aggPipeline).exec();
+        return query_1.AggregateBuilder.convertToAggregateResponse(aggResult);
+    }
+    count(filter) {
+        const filterQuery = this.filterQueryBuilder.buildFilterQuery(filter);
+        return this.Model.count(filterQuery).exec();
+    }
+    /**
+     * Find an entity by it's `id`.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.findById(1);
+     * ```
+     * @param id - The id of the record to find.
+     * @param opts - Additional options
+     */
+    async findById(id, opts) {
+        const filterQuery = this.filterQueryBuilder.buildIdFilterQuery(id, opts?.filter);
+        const doc = await this.Model.findOne(filterQuery);
+        if (!doc) {
+            return undefined;
+        }
+        return doc;
+    }
+    /**
+     * Gets an entity by it's `id`. If the entity is not found a rejected promise is returned.
+     *
+     * @example
+     * ```ts
+     * try {
+     *   const todoItem = await this.service.getById(1);
+     * } catch(e) {
+     *   console.error('Unable to find entity with id = 1');
+     * }
+     * ```
+     * @param id - The id of the record to find.
+     * @param opts - Additional options
+     */
+    async getById(id, opts) {
+        const doc = await this.findById(id, opts);
+        if (!doc) {
+            throw new common_1.NotFoundException(`Unable to find ${this.Model.modelName} with id: ${id}`);
+        }
+        return doc;
+    }
+    /**
+     * Creates a single entity.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.createOne({title: 'Todo Item', completed: false });
+     * ```
+     * @param record - The entity to create.
+     */
+    async createOne(record) {
+        this.ensureIdIsNotPresent(record);
+        return this.Model.create(record);
+    }
+    /**
+     * Create multiple entities.
+     *
+     * @example
+     * ```ts
+     * const todoItem = await this.service.createMany([
+     *   {title: 'Todo Item 1', completed: false },
+     *   {title: 'Todo Item 2', completed: true },
+     * ]);
+     * ```
+     * @param records - The entities to create.
+     */
+    async createMany(records) {
+        records.forEach((r) => this.ensureIdIsNotPresent(r));
+        return this.Model.create(records);
+    }
+    /**
+     * Update an entity.
+     *
+     * @example
+     * ```ts
+     * const updatedEntity = await this.service.updateOne(1, { completed: true });
+     * ```
+     * @param id - The `id` of the record.
+     * @param update - A `Partial` of the entity with fields to update.
+     * @param opts - Additional options
+     */
+    async updateOne(id, update, opts) {
+        this.ensureIdIsNotPresent(update);
+        const filterQuery = this.filterQueryBuilder.buildIdFilterQuery(id, opts?.filter);
+        const doc = await this.Model.findOneAndUpdate(filterQuery, this.getUpdateQuery(update), {
+            new: true
+        });
+        if (!doc) {
+            throw new common_1.NotFoundException(`Unable to find ${this.Model.modelName} with id: ${id}`);
+        }
+        return doc;
+    }
+    /**
+     * Update multiple entities with a `@ptc-org/nestjs-query-core` Filter.
+     *
+     * @example
+     * ```ts
+     * const { updatedCount } = await this.service.updateMany(
+     *   { completed: true }, // the update to apply
+     *   { title: { eq: 'Foo Title' } } // Filter to find records to update
+     * );
+     * ```
+     * @param update - A `Partial` of entity with the fields to update
+     * @param filter - A Filter used to find the records to update
+     */
+    async updateMany(update, filter) {
+        this.ensureIdIsNotPresent(update);
+        const filterQuery = this.filterQueryBuilder.buildFilterQuery(filter);
+        const res = await this.Model.updateMany(filterQuery, this.getUpdateQuery(update)).exec();
+        return { updatedCount: res.modifiedCount || 0 };
+    }
+    /**
+     * Delete an entity by `id`.
+     *
+     * @example
+     *
+     * ```ts
+     * const deletedTodo = await this.service.deleteOne(1);
+     * ```
+     *
+     * @param id - The `id` of the entity to delete.
+     * @param opts - Additional filter to use when finding the entity to delete.
+     */
+    async deleteOne(id, opts) {
+        const filterQuery = this.filterQueryBuilder.buildIdFilterQuery(id, opts?.filter);
+        const doc = await this.Model.findOneAndDelete(filterQuery);
+        if (!doc) {
+            throw new common_1.NotFoundException(`Unable to find ${this.Model.modelName} with id: ${id}`);
+        }
+        return doc;
+    }
+    /**
+     * Delete multiple records with a `@ptc-org/nestjs-query-core` `Filter`.
+     *
+     * @example
+     *
+     * ```ts
+     * const { deletedCount } = this.service.deleteMany({
+     *   created: { lte: new Date('2020-1-1') }
+     * });
+     * ```
+     *
+     * @param filter - A `Filter` to find records to delete.
+     */
+    async deleteMany(filter) {
+        const filterQuery = this.filterQueryBuilder.buildFilterQuery(filter);
+        const res = (await this.Model.deleteMany(filterQuery).exec());
+        return { deletedCount: res.deletedCount || 0 };
+    }
+    ensureIdIsNotPresent(e) {
+        if (Object.keys(e).find((f) => f === 'id' || f === '_id')) {
+            throw new Error('Id cannot be specified when updating or creating');
+        }
+    }
+    getUpdateQuery(entity) {
+        if (entity instanceof this.Model) {
+            return entity.modifiedPaths().reduce((update, k) => 
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            ({ ...update, [k]: entity.get(k) }), {});
+        }
+        return entity;
+    }
+}
+exports.MongooseQueryService = MongooseQueryService;
+//# sourceMappingURL=mongoose-query.service.js.map

package/src/services/mongoose-query.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongoose-query.service.js","sourceRoot":"","sources":["../../../../../packages/query-mongoose/src/services/mongoose-query.service.ts"],"names":[],"mappings":";;;AAAA,yCAAyC;AACzC,2CAAkD;AAiBlD,oCAA+D;AAC/D,uEAAiE;AAUjE;;;;;;;;;;;;;;;GAeG;AACH,MAAa,oBACX,SAAQ,+CAA6B;IAGrC,YACW,KAA4B,EAC5B,qBAAiD,IAAI,0BAAkB,CAAC,KAAK,CAAC;QAEvF,KAAK,EAAE,CAAA;QAHE,UAAK,GAAL,KAAK,CAAuB;QAC5B,uBAAkB,GAAlB,kBAAkB,CAA4D;IAGzF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK,CAAC,KAAoB;QAC9B,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QAC1E,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,CAAA;IACzD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,MAAsB,EAAE,cAAsC;QAC5E,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,cAAc,EAAE,MAAM,CAAC,CAAA;QAC/G,MAAM,WAAW,GAAoB,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAA;QACrF,IAAI,OAAO,CAAC,IAAI,EAAE;YAChB,WAAW,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC,CAAA;SAChD;QACD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAA0B,WAAW,CAAC,CAAC,IAAI,EAAE,CAAA;QACzF,OAAO,wBAAgB,CAAC,0BAA0B,CAAC,SAAS,CAAC,CAAA;IAC/D,CAAC;IAED,KAAK,CAAC,MAAsB;QAC1B,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QACpE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,CAAA;IAC7C,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAmB,EAAE,IAA8B;QAChE,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QAChF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QACjD,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,SAAS,CAAA;SACjB;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,OAAO,CAAC,EAAU,EAAE,IAA6B;QACrD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;QACzC,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,0BAAiB,CAAC,kBAAkB,IAAI,CAAC,KAAK,CAAC,SAAS,aAAa,EAAE,EAAE,CAAC,CAAA;SACrF;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAS,CAAC,MAA2B;QACzC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAA;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU,CAAC,OAA8B;QAC7C,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAA;QACpD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACnC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,SAAS,CAAC,EAAU,EAAE,MAA2B,EAAE,IAA+B;QACtF,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAA;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QAEhF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;YACtF,GAAG,EAAE,IAAI;SACV,CAAC,CAAA;QAEF,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,0BAAiB,CAAC,kBAAkB,IAAI,CAAC,KAAK,CAAC,SAAS,aAAa,EAAE,EAAE,CAAC,CAAA;SACrF;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CAAC,MAA2B,EAAE,MAAsB;QAClE,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAA;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QACpE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;QACxF,OAAO,EAAE,YAAY,EAAE,GAAG,CAAC,aAAa,IAAI,CAAC,EAAE,CAAA;IACjD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,SAAS,CAAC,EAAU,EAAE,IAA+B;QACzD,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QAChF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;QAC1D,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,0BAAiB,CAAC,kBAAkB,IAAI,CAAC,KAAK,CAAC,SAAS,aAAa,EAAE,EAAE,CAAC,CAAA;SACrF;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CAAC,MAAsB;QACrC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QACpE,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,CAAyB,CAAA;QACrF,OAAO,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,IAAI,CAAC,EAAE,CAAA;IAChD,CAAC;IAEO,oBAAoB,CAAC,CAAsB;QACjD,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE;YACzD,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;SACpE;IACH,CAAC;IAEO,cAAc,CAAC,MAA2B;QAChD,IAAI,MAAM,YAAY,IAAI,CAAC,KAAK,EAAE;YAChC,OAAO,MAAM,CAAC,aAAa,EAAE,CAAC,MAAM,CAClC,CAAC,MAA2B,EAAE,CAAC,EAAE,EAAE;YACjC,mEAAmE;YACnE,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EACrC,EAAE,CACH,CAAA;SACF;QACD,OAAO,MAA6B,CAAA;IACtC,CAAC;CACF;AA3ND,oDA2NC"}

package/src/services/reference-query.service.d.ts

@@ -0,0 +1,28 @@
+import { AggregateQuery, AggregateResponse, Class, Filter, FindRelationOptions, GetByIdOptions, ModifyRelationOptions, Query } from '@ptc-org/nestjs-query-core';
+import { Document, Model as MongooseModel } from 'mongoose';
+export declare abstract class ReferenceQueryService<Entity extends Document> {
+    abstract readonly Model: MongooseModel<Entity>;
+    abstract getById(id: string | number, opts?: GetByIdOptions<Entity>): Promise<Entity>;
+    aggregateRelations<Relation extends Document>(RelationClass: Class<Relation>, relationName: string, entities: Entity[], filter: Filter<Relation>, aggregate: AggregateQuery<Relation>): Promise<Map<Entity, AggregateResponse<Relation>[]>>;
+    aggregateRelations<Relation extends Document>(RelationClass: Class<Relation>, relationName: string, dto: Entity, filter: Filter<Relation>, aggregate: AggregateQuery<Relation>): Promise<AggregateResponse<Relation>[]>;
+    countRelations<Relation extends Document>(RelationClass: Class<Relation>, relationName: string, entities: Entity[], filter: Filter<Relation>): Promise<Map<Entity, number>>;
+    countRelations<Relation extends Document>(RelationClass: Class<Relation>, relationName: string, dto: Entity, filter: Filter<Relation>): Promise<number>;
+    findRelation<Relation>(RelationClass: Class<Relation>, relationName: string, dtos: Entity[], opts?: FindRelationOptions<Relation>): Promise<Map<Entity, Relation | undefined>>;
+    findRelation<Relation>(RelationClass: Class<Relation>, relationName: string, dto: Entity, opts?: FindRelationOptions<Relation>): Promise<Relation | undefined>;
+    queryRelations<Relation>(RelationClass: Class<Relation>, relationName: string, entities: Entity[], query: Query<Relation>): Promise<Map<Entity, Relation[]>>;
+    queryRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dto: Entity, query: Query<Relation>): Promise<Relation[]>;
+    addRelations<Relation extends Document>(relationName: string, id: string, relationIds: (string | number)[], opts?: ModifyRelationOptions<Entity, Relation>): Promise<Entity>;
+    setRelations<Relation extends Document>(relationName: string, id: string, relationIds: (string | number)[], opts?: ModifyRelationOptions<Entity, Relation>): Promise<Entity>;
+    setRelation<Relation extends Document>(relationName: string, id: string | number, relationId: string | number, opts?: ModifyRelationOptions<Entity, Relation>): Promise<Entity>;
+    removeRelation<Relation extends Document>(relationName: string, id: string | number, relationId: string | number, opts?: ModifyRelationOptions<Entity, Relation>): Promise<Entity>;
+    removeRelations<Relation extends Document>(relationName: string, id: string | number, relationIds: string[] | number[], opts?: ModifyRelationOptions<Entity, Relation>): Promise<Entity>;
+    private checkForReference;
+    private isReferencePath;
+    private isVirtualPath;
+    private getReferenceQueryBuilder;
+    private getReferenceModel;
+    private getReferenceFilter;
+    private getObjectIdReferenceFilter;
+    private getVirtualReferenceFilter;
+    private getRefCount;
+}