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

package/README.md

@@ -1,22 +1,23 @@
 <p align="center">
-  <a href="https://doug-martin.github.io/nestjs-query" target="blank"><img src="https://doug-martin.github.io/nestjs-query/img/logo.svg" width="120" alt="Nestjs-query Logo" /></a>
+  <a href="https://tripss.github.io/nestjs-query" target="blank"><img src="https://tripss.github.io/nestjs-query/img/logo.svg" width="120" alt="Nestjs-query Logo" /></a>
 </p>
 
 [![npm version](https://img.shields.io/npm/v/@nestjs-query/query-mongoose.svg)](https://www.npmjs.org/package/@nestjs-query/query-mongoose)
 [![Test](https://github.com/tripss/nestjs-query/workflows/Test/badge.svg?branch=master)](https://github.com/tripss/nestjs-query/actions?query=workflow%3ATest+and+branch%3Amaster+)
-[![Coverage Status](https://coveralls.io/repos/github/doug-martin/nestjs-query/badge.svg?branch=master)](https://coveralls.io/github/doug-martin/nestjs-query?branch=master)
-[![Known Vulnerabilities](https://snyk.io/test/github/doug-martin/nestjs-query/badge.svg?targetFile=packages/query-mongoose/package.json)](https://snyk.io/test/github/doug-martin/nestjs-query?targetFile=packages/query-mongoose/package.json)
+[![Coverage Status](https://coveralls.io/repos/github/tripss/nestjs-query/badge.svg?branch=master)](https://coveralls.io/github/tripss/nestjs-query?branch=master)
+[![Known Vulnerabilities](https://snyk.io/test/github/tripss/nestjs-query/badge.svg?targetFile=packages/query-mongoose/package.json)](https://snyk.io/test/github/tripss/nestjs-query?targetFile=packages/query-mongoose/package.json)
 
 # `@nestjs-query/query-mongoose`
 
-The `query-mongoose` package that provides an implementation of `@ptc-org/nestjs-query-core` `QueryService`, built on top of of [nestjs](https://nestjs.com/) and [mongoose](https://mongoosejs.com/). 
+The `query-mongoose` package that provides an implementation of `@ptc-org/nestjs-query-core` `QueryService`, built on
+top of of [nestjs](https://nestjs.com/) and [mongoose](https://mongoosejs.com/).
 
 ## Installation
 
-[Install Guide](https://doug-martin.github.io/nestjs-query/docs/introduction/install)
+[Install Guide](https://tripss.github.io/nestjs-query/docs/introduction/install)
 
 ## Getting Started
 
-The get started with the `@nestjs-query/query-mongoose` package checkout the [Getting Started](https://doug-martin.github.io/nestjs-query/docs/persistence/mongoose/getting-started) docs.
-
+The get started with the `@nestjs-query/query-mongoose` package checkout
+the [Getting Started](https://tripss.github.io/nestjs-query/docs/persistence/mongoose/getting-started) docs.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptc-org/nestjs-query-mongoose",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.1",
   "description": "Mongoose adapter for @ptc-org/nestjs-query-core",
   "author": "doug-martin <doug@dougamartin.com>",
   "homepage": "https://github.com/tripss/nestjs-query#readme",
@@ -12,7 +12,7 @@
     "test": "__tests__"
   },
   "files": [
-    "dist/src/**"
+    "src/**"
   ],
   "publishConfig": {
     "access": "public"
@@ -21,13 +21,13 @@
     "camel-case": "^4.1.2",
     "lodash.escaperegexp": "^4.1.2",
     "lodash.merge": "^4.6.2",
-    "tslib": "^2.1.0"
+    "tslib": "^2.4.0"
   },
   "peerDependencies": {
-    "@nestjs/common": "^8.0.4",
+    "@nestjs/common": "^8.0.0 || ^9.0.0",
     "@nestjs/mongoose": "^8.0.0 || ^9.0.0",
     "mongoose": "^5.10.0",
-    "@ptc-org/nestjs-query-core": "1.0.0-alpha.1",
+    "@ptc-org/nestjs-query-core": "1.0.1",
     "reflect-metadata": "^0.1.13"
   },
   "repository": {

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export { NestjsQueryMongooseModule } from './module';
+export { MongooseQueryService } from './services';

package/src/index.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NestjsQueryMongooseModule = exports.MongooseQueryService = void 0;
-var services_1 = require("./services");
-Object.defineProperty(exports, "MongooseQueryService", { enumerable: true, get: function () { return services_1.MongooseQueryService; } });
+exports.MongooseQueryService = exports.NestjsQueryMongooseModule = void 0;
 var module_1 = require("./module");
 Object.defineProperty(exports, "NestjsQueryMongooseModule", { enumerable: true, get: function () { return module_1.NestjsQueryMongooseModule; } });
+var services_1 = require("./services");
+Object.defineProperty(exports, "MongooseQueryService", { enumerable: true, get: function () { return services_1.MongooseQueryService; } });
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/query-mongoose/src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAoD;AAA3C,mHAAA,yBAAyB,OAAA;AAClC,uCAAiD;AAAxC,gHAAA,oBAAoB,OAAA"}

package/src/module.d.ts

@@ -0,0 +1,6 @@
+import { DynamicModule } from '@nestjs/common';
+import { Document } from 'mongoose';
+import { NestjsQueryModelDefinition } from './providers';
+export declare class NestjsQueryMongooseModule {
+    static forFeature(models: NestjsQueryModelDefinition<Document>[], connectionName?: string): DynamicModule;
+}

package/src/module.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NestjsQueryMongooseModule = void 0;
+const mongoose_1 = require("@nestjs/mongoose");
+const providers_1 = require("./providers");
+class NestjsQueryMongooseModule {
+    static forFeature(models, connectionName) {
+        const queryServiceProviders = (0, providers_1.createMongooseQueryServiceProviders)(models);
+        const mongooseModule = mongoose_1.MongooseModule.forFeature(models, connectionName);
+        return {
+            imports: [mongooseModule],
+            module: NestjsQueryMongooseModule,
+            providers: [...queryServiceProviders],
+            exports: [...queryServiceProviders, mongooseModule]
+        };
+    }
+}
+exports.NestjsQueryMongooseModule = NestjsQueryMongooseModule;
+//# sourceMappingURL=module.js.map

package/src/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../../../packages/query-mongoose/src/module.ts"],"names":[],"mappings":";;;AACA,+CAAiD;AAGjD,2CAA6F;AAE7F,MAAa,yBAAyB;IACpC,MAAM,CAAC,UAAU,CAAC,MAA8C,EAAE,cAAuB;QACvF,MAAM,qBAAqB,GAAG,IAAA,+CAAmC,EAAC,MAAM,CAAC,CAAA;QACzE,MAAM,cAAc,GAAG,yBAAc,CAAC,UAAU,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QACxE,OAAO;YACL,OAAO,EAAE,CAAC,cAAc,CAAC;YACzB,MAAM,EAAE,yBAAyB;YACjC,SAAS,EAAE,CAAC,GAAG,qBAAqB,CAAC;YACrC,OAAO,EAAE,CAAC,GAAG,qBAAqB,EAAE,cAAc,CAAC;SACpD,CAAA;IACH,CAAC;CACF;AAXD,8DAWC"}

package/src/mongoose-types.helper.d.ts

@@ -0,0 +1,26 @@
+import { SchemaType } from 'mongoose';
+export declare type ReferenceOptions = {
+    type: SchemaType;
+    ref: string;
+};
+export declare function isReferenceOptions(options: unknown): options is ReferenceOptions;
+export declare type SchemaTypeWithReferenceOptions = {
+    options: ReferenceOptions;
+};
+export declare function isSchemaTypeWithReferenceOptions(type: unknown): type is SchemaTypeWithReferenceOptions;
+export declare type EmbeddedSchemaTypeOptions = {
+    $embeddedSchemaType: {
+        options: ReferenceOptions;
+    };
+};
+export declare function isEmbeddedSchemaTypeOptions(options: unknown): options is EmbeddedSchemaTypeOptions;
+export declare type VirtualReferenceOptions = {
+    ref: string;
+    localField: string;
+    foreignField: string;
+};
+export declare function isVirtualReferenceOptions(options: unknown): options is VirtualReferenceOptions;
+export declare type VirtualTypeWithOptions = {
+    options: VirtualReferenceOptions;
+};
+export declare function isVirtualTypeWithReferenceOptions(virtualType: unknown): virtualType is VirtualTypeWithOptions;

package/src/mongoose-types.helper.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isVirtualTypeWithReferenceOptions = exports.isVirtualReferenceOptions = exports.isEmbeddedSchemaTypeOptions = exports.isSchemaTypeWithReferenceOptions = exports.isReferenceOptions = void 0;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function isReferenceOptions(options) {
+    return (typeof options === 'object' &&
+        options !== null &&
+        'type' in options &&
+        'ref' in options &&
+        typeof options.ref === 'string');
+}
+exports.isReferenceOptions = isReferenceOptions;
+function isSchemaTypeWithReferenceOptions(type) {
+    if (type && typeof type === 'object' && 'options' in type) {
+        const { options } = type;
+        return isReferenceOptions(options);
+    }
+    return false;
+}
+exports.isSchemaTypeWithReferenceOptions = isSchemaTypeWithReferenceOptions;
+function isEmbeddedSchemaTypeOptions(options) {
+    if (options && typeof options === 'object' && '$embeddedSchemaType' in options) {
+        const { $embeddedSchemaType } = options;
+        return isReferenceOptions($embeddedSchemaType.options);
+    }
+    return false;
+}
+exports.isEmbeddedSchemaTypeOptions = isEmbeddedSchemaTypeOptions;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function isVirtualReferenceOptions(options) {
+    return (typeof options === 'object' && options !== null && 'ref' in options && 'localField' in options && 'foreignField' in options);
+}
+exports.isVirtualReferenceOptions = isVirtualReferenceOptions;
+function isVirtualTypeWithReferenceOptions(virtualType) {
+    if (virtualType && typeof virtualType === 'object' && 'options' in virtualType) {
+        const { options } = virtualType;
+        return isVirtualReferenceOptions(options);
+    }
+    return false;
+}
+exports.isVirtualTypeWithReferenceOptions = isVirtualTypeWithReferenceOptions;
+//# sourceMappingURL=mongoose-types.helper.js.map

package/src/mongoose-types.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongoose-types.helper.js","sourceRoot":"","sources":["../../../../packages/query-mongoose/src/mongoose-types.helper.ts"],"names":[],"mappings":";;;AAOA,8DAA8D;AAC9D,SAAgB,kBAAkB,CAAC,OAAgB;IACjD,OAAO,CACL,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,KAAK,IAAI;QAChB,MAAM,IAAI,OAAO;QACjB,KAAK,IAAI,OAAO;QAChB,OAAQ,OAA4B,CAAC,GAAG,KAAK,QAAQ,CACtD,CAAA;AACH,CAAC;AARD,gDAQC;AAMD,SAAgB,gCAAgC,CAAC,IAAa;IAC5D,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,SAAS,IAAI,IAAI,EAAE;QACzD,MAAM,EAAE,OAAO,EAAE,GAAG,IAA4B,CAAA;QAChD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAA;KACnC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAND,4EAMC;AAMD,SAAgB,2BAA2B,CAAC,OAAgB;IAC1D,IAAI,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,qBAAqB,IAAI,OAAO,EAAE;QAC9E,MAAM,EAAE,mBAAmB,EAAE,GAAG,OAAwD,CAAA;QACxF,OAAO,kBAAkB,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAA;KACvD;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAND,kEAMC;AAQD,8DAA8D;AAC9D,SAAgB,yBAAyB,CAAC,OAAgB;IACxD,OAAO,CACL,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,IAAI,KAAK,IAAI,OAAO,IAAI,YAAY,IAAI,OAAO,IAAI,cAAc,IAAI,OAAO,CAC5H,CAAA;AACH,CAAC;AAJD,8DAIC;AAMD,SAAgB,iCAAiC,CAAC,WAAoB;IACpE,IAAI,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,SAAS,IAAI,WAAW,EAAE;QAC9E,MAAM,EAAE,OAAO,EAAE,GAAG,WAAmC,CAAA;QACvD,OAAO,yBAAyB,CAAC,OAAO,CAAC,CAAA;KAC1C;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAND,8EAMC"}

package/src/providers.d.ts

@@ -0,0 +1,8 @@
+import { FactoryProvider } from '@nestjs/common';
+import { ModelDefinition } from '@nestjs/mongoose';
+import { Class } from '@ptc-org/nestjs-query-core';
+import { Document } from 'mongoose';
+export declare type NestjsQueryModelDefinition<Entity extends Document> = {
+    document: Class<Entity>;
+} & ModelDefinition;
+export declare const createMongooseQueryServiceProviders: (models: NestjsQueryModelDefinition<Document>[]) => FactoryProvider[];

package/src/providers.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMongooseQueryServiceProviders = void 0;
+const mongoose_1 = require("@nestjs/mongoose");
+const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
+const mongoose_2 = require("mongoose");
+const services_1 = require("./services");
+// initialize default serializer for documents, this is the type that mongoose returns from queries
+// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+(0, nestjs_query_core_1.AssemblerSerializer)((obj) => obj.toObject({ virtuals: true }))(mongoose_2.Document);
+function createMongooseQueryServiceProvider(model) {
+    return {
+        provide: (0, nestjs_query_core_1.getQueryServiceToken)(model.document),
+        useFactory(ModelClass) {
+            // eslint-disable-next-line @typescript-eslint/ban-types
+            (0, nestjs_query_core_1.AssemblerDeserializer)((obj) => new ModelClass(obj))(model.document);
+            // eslint-disable-next-line @typescript-eslint/ban-types
+            return new services_1.MongooseQueryService(ModelClass);
+        },
+        inject: [(0, mongoose_1.getModelToken)(model.name)]
+    };
+}
+const createMongooseQueryServiceProviders = (models) => models.map((model) => createMongooseQueryServiceProvider(model));
+exports.createMongooseQueryServiceProviders = createMongooseQueryServiceProviders;
+//# sourceMappingURL=providers.js.map

package/src/providers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.js","sourceRoot":"","sources":["../../../../packages/query-mongoose/src/providers.ts"],"names":[],"mappings":";;;AACA,+CAAiE;AACjE,kEAAoH;AACpH,uCAA0C;AAE1C,yCAAiD;AAMjD,mGAAmG;AACnG,+DAA+D;AAC/D,IAAA,uCAAmB,EAAC,CAAC,GAAa,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,mBAAQ,CAAC,CAAA;AAElF,SAAS,kCAAkC,CAA0B,KAAyC;IAC5G,OAAO;QACL,OAAO,EAAE,IAAA,wCAAoB,EAAC,KAAK,CAAC,QAAQ,CAAC;QAC7C,UAAU,CAAC,UAAyB;YAClC,wDAAwD;YACxD,IAAA,yCAAqB,EAAS,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;YACnF,wDAAwD;YACxD,OAAO,IAAI,+BAAoB,CAAS,UAAU,CAAC,CAAA;QACrD,CAAC;QACD,MAAM,EAAE,CAAC,IAAA,wBAAa,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC;KACpC,CAAA;AACH,CAAC;AAEM,MAAM,mCAAmC,GAAG,CAAC,MAA8C,EAAqB,EAAE,CACvH,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,kCAAkC,CAAC,KAAK,CAAC,CAAC,CAAA;AADrD,QAAA,mCAAmC,uCACkB"}

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

@@ -0,0 +1,25 @@
+import { AggregateQuery, AggregateResponse } from '@ptc-org/nestjs-query-core';
+import { Document } from 'mongoose';
+declare type Aggregate = Record<string, Record<string, unknown>>;
+declare type Group = {
+    _id: Record<string, string> | null;
+};
+export declare type MongooseGroupAndAggregate = Aggregate & Group;
+/**
+ * @internal
+ * Builds a WHERE clause from a Filter.
+ */
+export declare class AggregateBuilder<Entity extends Document> {
+    static convertToAggregateResponse<Entity>(aggregates: Record<string, unknown>[]): AggregateResponse<Entity>[];
+    private static extractResponse;
+    /**
+     * Builds a aggregate SELECT clause from a aggregate.
+     * @param aggregate - the aggregates to select.
+     */
+    build(aggregate: AggregateQuery<Entity>): MongooseGroupAndAggregate;
+    private createAggSelect;
+    private createGroupBySelect;
+    getGroupBySelects(fields?: (keyof Entity)[]): string[] | undefined;
+    private getGroupByAlias;
+}
+export {};

package/src/query/aggregate.builder.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AggregateBuilder = void 0;
+const common_1 = require("@nestjs/common");
+const camel_case_1 = require("camel-case");
+const helpers_1 = require("./helpers");
+var AggregateFuncs;
+(function (AggregateFuncs) {
+    AggregateFuncs["AVG"] = "avg";
+    AggregateFuncs["SUM"] = "sum";
+    AggregateFuncs["COUNT"] = "count";
+    AggregateFuncs["MAX"] = "max";
+    AggregateFuncs["MIN"] = "min";
+})(AggregateFuncs || (AggregateFuncs = {}));
+const AGG_REGEXP = /(avg|sum|count|max|min|group_by)_(.*)/;
+/**
+ * @internal
+ * Builds a WHERE clause from a Filter.
+ */
+class AggregateBuilder {
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    static convertToAggregateResponse(aggregates) {
+        return aggregates.map(({ _id, ...response }) => {
+            return { ...this.extractResponse(_id), ...this.extractResponse(response) };
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    static extractResponse(response) {
+        if (!response) {
+            return {};
+        }
+        return Object.keys(response).reduce((agg, resultField) => {
+            const matchResult = AGG_REGEXP.exec(resultField);
+            if (!matchResult) {
+                throw new Error('Unknown aggregate column encountered.');
+            }
+            const [matchedFunc, matchedFieldName] = matchResult.slice(1);
+            const aggFunc = (0, camel_case_1.camelCase)(matchedFunc.toLowerCase());
+            const fieldName = matchedFieldName;
+            const aggResult = agg[aggFunc] || {};
+            return {
+                ...agg,
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                [aggFunc]: { ...aggResult, [fieldName]: response[resultField] }
+            };
+        }, {});
+    }
+    /**
+     * Builds a aggregate SELECT clause from a aggregate.
+     * @param aggregate - the aggregates to select.
+     */
+    build(aggregate) {
+        const aggSelect = {
+            ...this.createAggSelect(AggregateFuncs.COUNT, aggregate.count),
+            ...this.createAggSelect(AggregateFuncs.SUM, aggregate.sum),
+            ...this.createAggSelect(AggregateFuncs.AVG, aggregate.avg),
+            ...this.createAggSelect(AggregateFuncs.MAX, aggregate.max),
+            ...this.createAggSelect(AggregateFuncs.MIN, aggregate.min)
+        };
+        if (!Object.keys(aggSelect).length) {
+            throw new common_1.BadRequestException('No aggregate fields found.');
+        }
+        return { ...aggSelect, _id: this.createGroupBySelect(aggregate.groupBy) };
+    }
+    createAggSelect(func, fields) {
+        if (!fields) {
+            return {};
+        }
+        return fields.reduce((agg, field) => {
+            const aggAlias = `${func}_${field}`;
+            const fieldAlias = `$${(0, helpers_1.getSchemaKey)(String(field))}`;
+            if (func === 'count') {
+                return {
+                    ...agg,
+                    [aggAlias]: {
+                        $sum: {
+                            $cond: {
+                                if: { $in: [{ $type: fieldAlias }, ['missing', 'null']] },
+                                then: 0,
+                                else: 1
+                            }
+                        }
+                    }
+                };
+            }
+            return { ...agg, [aggAlias]: { [`$${func}`]: fieldAlias } };
+        }, {});
+    }
+    createGroupBySelect(fields) {
+        if (!fields) {
+            return null;
+        }
+        return fields.reduce((id, field) => {
+            const aggAlias = this.getGroupByAlias(field);
+            const fieldAlias = `$${(0, helpers_1.getSchemaKey)(String(field))}`;
+            return { ...id, [aggAlias]: fieldAlias };
+        }, {});
+    }
+    getGroupBySelects(fields) {
+        if (!fields) {
+            return undefined;
+        }
+        // append _id so it pulls the sort from the _id field
+        return (fields ?? []).map((f) => `_id.${this.getGroupByAlias(f)}`);
+    }
+    getGroupByAlias(field) {
+        return `group_by_${field}`;
+    }
+}
+exports.AggregateBuilder = AggregateBuilder;
+//# sourceMappingURL=aggregate.builder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"aggregate.builder.js","sourceRoot":"","sources":["../../../../../packages/query-mongoose/src/query/aggregate.builder.ts"],"names":[],"mappings":";;;AAAA,2CAAoD;AAEpD,2CAAsC;AAGtC,uCAAwC;AAExC,IAAK,cAMJ;AAND,WAAK,cAAc;IACjB,6BAAW,CAAA;IACX,6BAAW,CAAA;IACX,iCAAe,CAAA;IACf,6BAAW,CAAA;IACX,6BAAW,CAAA;AACb,CAAC,EANI,cAAc,KAAd,cAAc,QAMlB;AAMD,MAAM,UAAU,GAAG,uCAAuC,CAAA;AAE1D;;;GAGG;AACH,MAAa,gBAAgB;IAC3B,wDAAwD;IACxD,MAAM,CAAC,0BAA0B,CAAS,UAAqC;QAC7E,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,QAAQ,EAAE,EAAE,EAAE;YAC7C,OAAO,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,GAA8B,CAAC,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAA;QACvG,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,wDAAwD;IAChD,MAAM,CAAC,eAAe,CAAS,QAAkC;QACvE,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,EAAE,CAAA;SACV;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,WAAmB,EAAE,EAAE;YAC/D,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;YAChD,IAAI,CAAC,WAAW,EAAE;gBAChB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;aACzD;YACD,MAAM,CAAC,WAAW,EAAE,gBAAgB,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC5D,MAAM,OAAO,GAAG,IAAA,sBAAS,EAAC,WAAW,CAAC,WAAW,EAAE,CAAoC,CAAA;YACvF,MAAM,SAAS,GAAG,gBAAgC,CAAA;YAClD,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;YACpC,OAAO;gBACL,GAAG,GAAG;gBACN,mEAAmE;gBACnE,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE;aAChE,CAAA;QACH,CAAC,EAAE,EAA+B,CAAC,CAAA;IACrC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAiC;QACrC,MAAM,SAAS,GAAc;YAC3B,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC;YAC9D,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC;YAC1D,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC;YAC1D,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC;YAC1D,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC;SAC3D,CAAA;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE;YAClC,MAAM,IAAI,4BAAmB,CAAC,4BAA4B,CAAC,CAAA;SAC5D;QACD,OAAO,EAAE,GAAG,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,OAAO,CAAC,EAA+B,CAAA;IACxG,CAAC;IAEO,eAAe,CAAC,IAAoB,EAAE,MAAyB;QACrE,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,EAAE,CAAA;SACV;QACD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,GAAc,EAAE,KAAK,EAAE,EAAE;YAC7C,MAAM,QAAQ,GAAG,GAAG,IAAI,IAAI,KAAe,EAAE,CAAA;YAC7C,MAAM,UAAU,GAAG,IAAI,IAAA,sBAAY,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAA;YACpD,IAAI,IAAI,KAAK,OAAO,EAAE;gBACpB,OAAO;oBACL,GAAG,GAAG;oBACN,CAAC,QAAQ,CAAC,EAAE;wBACV,IAAI,EAAE;4BACJ,KAAK,EAAE;gCACL,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,EAAE;gCACzD,IAAI,EAAE,CAAC;gCACP,IAAI,EAAE,CAAC;6BACR;yBACF;qBACF;iBACF,CAAA;aACF;YACD,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,CAAA;QAC7D,CAAC,EAAE,EAAE,CAAC,CAAA;IACR,CAAC;IAEO,mBAAmB,CAAC,MAAyB;QACnD,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,CAAA;SACZ;QACD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,EAA0B,EAAE,KAAK,EAAE,EAAE;YACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;YAC5C,MAAM,UAAU,GAAG,IAAI,IAAA,sBAAY,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAA;YACpD,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAA;QAC1C,CAAC,EAAE,EAAE,CAAC,CAAA;IACR,CAAC;IAED,iBAAiB,CAAC,MAAyB;QACzC,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAA;SACjB;QACD,qDAAqD;QACrD,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IACpE,CAAC;IAEO,eAAe,CAAC,KAAmB;QACzC,OAAO,YAAY,KAAe,EAAE,CAAA;IACtC,CAAC;CACF;AA/FD,4CA+FC"}

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

@@ -0,0 +1,29 @@
+import { CommonFieldComparisonBetweenType, FilterComparisonOperators } from '@ptc-org/nestjs-query-core';
+import { Document, FilterQuery, Model as MongooseModel } from 'mongoose';
+/**
+ * @internal
+ */
+export declare type EntityComparisonField<Entity, F extends keyof Entity> = Entity[F] | Entity[F][] | CommonFieldComparisonBetweenType<Entity[F]> | true | false | null;
+/**
+ * @internal
+ * Builder to create SQL Comparisons. (=, !=, \>, etc...)
+ */
+export declare class ComparisonBuilder<Entity extends Document> {
+    readonly Model: MongooseModel<Entity>;
+    readonly comparisonMap: Record<string, string>;
+    static DEFAULT_COMPARISON_MAP: Record<string, string>;
+    constructor(Model: MongooseModel<Entity>, comparisonMap?: Record<string, string>);
+    /**
+     * Creates a valid SQL fragment with parameters.
+     *
+     * @param field - the property in Entity to create the comparison for.
+     * @param cmp - the FilterComparisonOperator (eq, neq, gt, etc...)
+     * @param val - the value to compare to.
+     */
+    build<F extends keyof Entity>(field: F, cmp: FilterComparisonOperators<Entity[F]>, val: EntityComparisonField<Entity, F>): FilterQuery<Entity>;
+    private betweenComparison;
+    private isBetweenVal;
+    private likeComparison;
+    private convertQueryValue;
+    private convertToObjectId;
+}

package/src/query/comparison.builder.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComparisonBuilder = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const lodash_escaperegexp_1 = (0, tslib_1.__importDefault)(require("lodash.escaperegexp"));
+const mongoose_1 = require("mongoose");
+const helpers_1 = require("./helpers");
+/**
+ * @internal
+ * Builder to create SQL Comparisons. (=, !=, \>, etc...)
+ */
+class ComparisonBuilder {
+    constructor(Model, comparisonMap = ComparisonBuilder.DEFAULT_COMPARISON_MAP) {
+        this.Model = Model;
+        this.comparisonMap = comparisonMap;
+    }
+    /**
+     * Creates a valid SQL fragment with parameters.
+     *
+     * @param field - the property in Entity to create the comparison for.
+     * @param cmp - the FilterComparisonOperator (eq, neq, gt, etc...)
+     * @param val - the value to compare to.
+     */
+    build(field, cmp, val) {
+        const schemaKey = (0, helpers_1.getSchemaKey)(`${String(field)}`);
+        const normalizedCmp = cmp.toLowerCase();
+        let querySelector;
+        if (this.comparisonMap[normalizedCmp]) {
+            // comparison operator (e.b. =, !=, >, <)
+            querySelector = {
+                [this.comparisonMap[normalizedCmp]]: this.convertQueryValue(field, val)
+            };
+        }
+        if (normalizedCmp.includes('like')) {
+            querySelector = this.likeComparison(normalizedCmp, val);
+        }
+        if (normalizedCmp.includes('between')) {
+            querySelector = this.betweenComparison(normalizedCmp, field, val);
+        }
+        if (!querySelector) {
+            throw new common_1.BadRequestException(`unknown operator ${JSON.stringify(cmp)}`);
+        }
+        return { [schemaKey]: querySelector };
+    }
+    betweenComparison(cmp, field, val) {
+        if (!this.isBetweenVal(val)) {
+            throw new Error(`Invalid value for ${cmp} expected {lower: val, upper: val} got ${JSON.stringify(val)}`);
+        }
+        if (cmp === 'notbetween') {
+            return { $lt: this.convertQueryValue(field, val.lower), $gt: this.convertQueryValue(field, val.upper) };
+        }
+        return { $gte: this.convertQueryValue(field, val.lower), $lte: this.convertQueryValue(field, val.upper) };
+    }
+    isBetweenVal(val) {
+        return val !== null && typeof val === 'object' && 'lower' in val && 'upper' in val;
+    }
+    likeComparison(cmp, val) {
+        const regExpStr = (0, lodash_escaperegexp_1.default)(`${String(val)}`).replace(/%/g, '.*');
+        const regExp = new RegExp(regExpStr, cmp.includes('ilike') ? 'i' : undefined);
+        if (cmp.startsWith('not')) {
+            return { $not: { $regex: regExp } };
+        }
+        return { $regex: regExp };
+    }
+    convertQueryValue(field, val) {
+        const schemaType = this.Model.schema.path((0, helpers_1.getSchemaKey)(field));
+        if (!schemaType) {
+            throw new common_1.BadRequestException(`unknown comparison field ${String(field)}`);
+        }
+        if (schemaType instanceof mongoose_1.Schema.Types.ObjectId) {
+            return this.convertToObjectId(val);
+        }
+        return val;
+    }
+    convertToObjectId(val) {
+        if (Array.isArray(val)) {
+            return val.map((v) => this.convertToObjectId(v));
+        }
+        if (typeof val === 'string' || typeof val === 'number') {
+            if (mongoose_1.Types.ObjectId.isValid(val)) {
+                return new mongoose_1.Types.ObjectId(val);
+            }
+        }
+        return val;
+    }
+}
+exports.ComparisonBuilder = ComparisonBuilder;
+ComparisonBuilder.DEFAULT_COMPARISON_MAP = {
+    eq: '$eq',
+    neq: '$ne',
+    gt: '$gt',
+    gte: '$gte',
+    lt: '$lt',
+    lte: '$lte',
+    in: '$in',
+    notin: '$nin',
+    is: '$eq',
+    isnot: '$ne'
+};
+//# sourceMappingURL=comparison.builder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"comparison.builder.js","sourceRoot":"","sources":["../../../../../packages/query-mongoose/src/query/comparison.builder.ts"],"names":[],"mappings":";;;;AAAA,2CAAoD;AAEpD,2FAA8C;AAC9C,uCAAuF;AAEvF,uCAAwC;AAaxC;;;GAGG;AACH,MAAa,iBAAiB;IAc5B,YACW,KAA4B,EAC5B,gBAAwC,iBAAiB,CAAC,sBAAsB;QADhF,UAAK,GAAL,KAAK,CAAuB;QAC5B,kBAAa,GAAb,aAAa,CAAmE;IACxF,CAAC;IAEJ;;;;;;OAMG;IACH,KAAK,CACH,KAAQ,EACR,GAAyC,EACzC,GAAqC;QAErC,MAAM,SAAS,GAAG,IAAA,sBAAY,EAAC,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAClD,MAAM,aAAa,GAAI,GAAc,CAAC,WAAW,EAAE,CAAA;QACnD,IAAI,aAAiD,CAAA;QACrD,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE;YACrC,yCAAyC;YACzC,aAAa,GAAG;gBACd,CAAC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,GAAgB,CAAC;aAC3D,CAAA;SAC5B;QAED,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YAClC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;SACxD;QAED,IAAI,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;YACrC,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;SAClE;QAED,IAAI,CAAC,aAAa,EAAE;YAClB,MAAM,IAAI,4BAAmB,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;SACzE;QAED,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE,aAAa,EAAyB,CAAA;IAC9D,CAAC;IAEO,iBAAiB,CACvB,GAAW,EACX,KAAQ,EACR,GAAqC;QAErC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,0CAA0C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;SACzG;QACD,IAAI,GAAG,KAAK,YAAY,EAAE;YACxB,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAA;SACxG;QACD,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAA;IAC3G,CAAC;IAEO,YAAY,CAClB,GAAqC;QAErC,OAAO,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,IAAI,GAAG,IAAI,OAAO,IAAI,GAAG,CAAA;IACpF,CAAC;IAEO,cAAc,CAAyB,GAAW,EAAE,GAAqC;QAC/F,MAAM,SAAS,GAAG,IAAA,6BAAY,EAAC,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QACpE,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;QAE7E,IAAI,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;YACzB,OAAO,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAA;SACpC;QAED,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA;IAC3B,CAAC;IAEO,iBAAiB,CAAyB,KAAQ,EAAE,GAAc;QACxE,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAA,sBAAY,EAAC,KAAe,CAAC,CAAC,CAAA;QACxE,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,4BAAmB,CAAC,4BAA4B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;SAC3E;QACD,IAAI,UAAU,YAAY,iBAAM,CAAC,KAAK,CAAC,QAAQ,EAAE;YAC/C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAc,CAAA;SAChD;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;IAEO,iBAAiB,CAAC,GAAY;QACpC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAA;SACjD;QACD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YACtD,IAAI,gBAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBAC/B,OAAO,IAAI,gBAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;aAC/B;SACF;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;;AA5GH,8CA6GC;AA5GQ,wCAAsB,GAA2B;IACtD,EAAE,EAAE,KAAK;IACT,GAAG,EAAE,KAAK;IACV,EAAE,EAAE,KAAK;IACT,GAAG,EAAE,MAAM;IACX,EAAE,EAAE,KAAK;IACT,GAAG,EAAE,MAAM;IACX,EAAE,EAAE,KAAK;IACT,KAAK,EAAE,MAAM;IACb,EAAE,EAAE,KAAK;IACT,KAAK,EAAE,KAAK;CACb,CAAA"}

package/src/query/filter-query.builder.d.ts

@@ -0,0 +1,44 @@
+import { AggregateQuery, Filter, Query, SortField } from '@ptc-org/nestjs-query-core';
+import { Document, FilterQuery, Model as MongooseModel } from 'mongoose';
+import { AggregateBuilder, MongooseGroupAndAggregate } from './aggregate.builder';
+import { WhereBuilder } from './where.builder';
+declare type MongooseSort = Record<string, 1 | -1>;
+declare type MongooseQuery<Entity extends Document> = {
+    filterQuery: FilterQuery<Entity>;
+    options: {
+        limit?: number;
+        skip?: number;
+        sort?: MongooseSort;
+    };
+};
+declare type MongooseAggregateQuery<Entity extends Document> = MongooseQuery<Entity> & {
+    aggregate: MongooseGroupAndAggregate;
+};
+/**
+ * @internal
+ *
+ * Class that will convert a Query into a `typeorm` Query Builder.
+ */
+export declare class FilterQueryBuilder<Entity extends Document> {
+    readonly Model: MongooseModel<Entity>;
+    readonly whereBuilder: WhereBuilder<Entity>;
+    readonly aggregateBuilder: AggregateBuilder<Entity>;
+    constructor(Model: MongooseModel<Entity>, whereBuilder?: WhereBuilder<Entity>, aggregateBuilder?: AggregateBuilder<Entity>);
+    buildQuery({ filter, paging, sorting }: Query<Entity>): MongooseQuery<Entity>;
+    buildAggregateQuery(aggregate: AggregateQuery<Entity>, filter?: Filter<Entity>): MongooseAggregateQuery<Entity>;
+    buildIdAggregateQuery(id: unknown | unknown[], filter: Filter<Entity>, aggregate: AggregateQuery<Entity>): MongooseAggregateQuery<Entity>;
+    buildIdFilterQuery(id: unknown | unknown[], filter?: Filter<Entity>): FilterQuery<Entity>;
+    /**
+     * Applies the filter from a Query to a `typeorm` QueryBuilder.
+     *
+     * @param filter - the filter.
+     */
+    buildFilterQuery(filter?: Filter<Entity>): FilterQuery<Entity>;
+    /**
+     * Applies the ORDER BY clause to a `typeorm` QueryBuilder.
+     * @param sorts - an array of SortFields to create the ORDER BY clause.
+     */
+    buildSorting(sorts?: SortField<Entity>[]): MongooseSort | undefined;
+    private buildAggregateSorting;
+}
+export {};