@ptc-org/nestjs-query-sequelize 1.0.0-alpha.1 → 2.0.0-alpha.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/@ptc-org/nestjs-query-sequelize.svg)](https://www.npmjs.org/package/@ptc-org/nestjs-query-sequelize)
 [![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-sequelize/package.json)](https://snyk.io/test/github/doug-martin/nestjs-query?targetFile=packages/query-sequelize/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-sequelize/package.json)](https://snyk.io/test/github/tripss/nestjs-query?targetFile=packages/query-sequelize/package.json)
 
 # `@ptc-org/nestjs-query-sequelize`
 
-The `query-sequelize` package that provides an implementation of `@ptc-org/nestjs-query-core` `QueryService`, built on top of of [nestjs](https://nestjs.com/) and [sequelize](https://sequelize.org/). 
+The `query-sequelize` package that provides an implementation of `@ptc-org/nestjs-query-core` `QueryService`, built on
+top of of [nestjs](https://nestjs.com/) and [sequelize](https://sequelize.org/).
 
 ## 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 `@ptc-org/nestjs-query-sequelize` package checkout the [Getting Started](https://doug-martin.github.io/nestjs-query/docs/sequelize/getting-started) docs.
-
+The get started with the `@ptc-org/nestjs-query-sequelize` package checkout
+the [Getting Started](https://tripss.github.io/nestjs-query/docs/sequelize/getting-started) docs.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptc-org/nestjs-query-sequelize",
-  "version": "1.0.0-alpha.1",
+  "version": "2.0.0-alpha.1",
   "description": "Sequelize 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"
@@ -20,14 +20,14 @@
   "dependencies": {
     "camel-case": "^4.1.2",
     "lodash.pick": "4.4.0",
-    "tslib": "^2.1.0"
+    "tslib": "^2.4.0"
   },
   "peerDependencies": {
     "@nestjs/common": "^8.0.4",
     "@nestjs/sequelize": "^8.0.0",
     "sequelize": "^6.5.0",
     "sequelize-typescript": "^1.1.0 || ^2.0.0",
-    "@ptc-org/nestjs-query-core": "1.0.0-alpha.1",
+    "@ptc-org/nestjs-query-core": "2.0.0-alpha.1",
     "reflect-metadata": "^0.1.13"
   },
   "repository": {

package/src/index.d.ts

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

package/src/index.js

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

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/query-sequelize/src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAqD;AAA5C,oHAAA,0BAA0B,OAAA;AACnC,uCAAkD;AAAzC,iHAAA,qBAAqB,OAAA"}

package/src/module.d.ts

@@ -0,0 +1,5 @@
+import { DynamicModule } from '@nestjs/common';
+import { ModelCtor, SequelizeOptions } from 'sequelize-typescript';
+export declare class NestjsQuerySequelizeModule {
+    static forFeature(entities: ModelCtor[], connection?: SequelizeOptions | string): DynamicModule;
+}

package/src/module.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NestjsQuerySequelizeModule = void 0;
+const sequelize_1 = require("@nestjs/sequelize");
+const providers_1 = require("./providers");
+class NestjsQuerySequelizeModule {
+    static forFeature(entities, connection) {
+        const queryServiceProviders = (0, providers_1.createSequelizeQueryServiceProviders)(entities, connection);
+        const nestjsSequelize = sequelize_1.SequelizeModule.forFeature(entities);
+        return {
+            module: NestjsQuerySequelizeModule,
+            imports: [nestjsSequelize],
+            providers: [...queryServiceProviders],
+            exports: [...queryServiceProviders, nestjsSequelize]
+        };
+    }
+}
+exports.NestjsQuerySequelizeModule = NestjsQuerySequelizeModule;
+//# sourceMappingURL=module.js.map

package/src/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../../../packages/query-sequelize/src/module.ts"],"names":[],"mappings":";;;AACA,iDAAmD;AAGnD,2CAAkE;AAElE,MAAa,0BAA0B;IACrC,MAAM,CAAC,UAAU,CAAC,QAAqB,EAAE,UAAsC;QAC7E,MAAM,qBAAqB,GAAG,IAAA,gDAAoC,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;QACxF,MAAM,eAAe,GAAG,2BAAe,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QAC5D,OAAO;YACL,MAAM,EAAE,0BAA0B;YAClC,OAAO,EAAE,CAAC,eAAe,CAAC;YAC1B,SAAS,EAAE,CAAC,GAAG,qBAAqB,CAAC;YACrC,OAAO,EAAE,CAAC,GAAG,qBAAqB,EAAE,eAAe,CAAC;SACrD,CAAA;IACH,CAAC;CACF;AAXD,gEAWC"}

package/src/providers.d.ts

@@ -0,0 +1,3 @@
+import { FactoryProvider } from '@nestjs/common';
+import { ModelCtor, SequelizeOptions } from 'sequelize-typescript';
+export declare const createSequelizeQueryServiceProviders: (entities: ModelCtor[], connection?: SequelizeOptions | string) => FactoryProvider[];

package/src/providers.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSequelizeQueryServiceProviders = void 0;
+const sequelize_1 = require("@nestjs/sequelize");
+const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
+const services_1 = require("./services");
+function createSequelizeQueryServiceProvider(EntityClass, connection) {
+    return {
+        provide: (0, nestjs_query_core_1.getQueryServiceToken)(EntityClass),
+        useFactory(entity) {
+            (0, nestjs_query_core_1.AssemblerSerializer)((instance) => instance.get({ plain: true }))(entity);
+            // eslint-disable-next-line @typescript-eslint/ban-types
+            (0, nestjs_query_core_1.AssemblerDeserializer)((obj) => entity.build(obj))(entity);
+            return new services_1.SequelizeQueryService(entity);
+        },
+        inject: [(0, sequelize_1.getModelToken)(EntityClass, connection)]
+    };
+}
+const createSequelizeQueryServiceProviders = (entities, connection) => entities.map((entity) => createSequelizeQueryServiceProvider(entity, connection));
+exports.createSequelizeQueryServiceProviders = createSequelizeQueryServiceProviders;
+//# sourceMappingURL=providers.js.map

package/src/providers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.js","sourceRoot":"","sources":["../../../../packages/query-sequelize/src/providers.ts"],"names":[],"mappings":";;;AACA,iDAAiD;AACjD,kEAA6G;AAI7G,yCAAkD;AAElD,SAAS,mCAAmC,CAC1C,WAA8B,EAC9B,UAAsC;IAEtC,OAAO;QACL,OAAO,EAAE,IAAA,wCAAoB,EAAC,WAAW,CAAC;QAC1C,UAAU,CAAC,MAAyB;YAClC,IAAA,uCAAmB,EAAS,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAW,CAAC,CAAC,MAAM,CAAC,CAAA;YAC1F,wDAAwD;YACxD,IAAA,yCAAqB,EAAS,CAAC,GAAgC,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;YAC9F,OAAO,IAAI,gCAAqB,CAAC,MAAM,CAAC,CAAA;QAC1C,CAAC;QACD,MAAM,EAAE,CAAC,IAAA,yBAAa,EAAC,WAAW,EAAE,UAAU,CAAC,CAAC;KACjD,CAAA;AACH,CAAC;AAEM,MAAM,oCAAoC,GAAG,CAClD,QAAqB,EACrB,UAAsC,EACnB,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mCAAmC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAA;AAH5F,QAAA,oCAAoC,wCAGwD"}

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

@@ -0,0 +1,19 @@
+import { AggregateQuery, AggregateResponse } from '@ptc-org/nestjs-query-core';
+import { Projectable } from 'sequelize';
+import { Model, ModelCtor } from 'sequelize-typescript';
+/**
+ * @internal
+ * Builds a WHERE clause from a Filter.
+ */
+export declare class AggregateBuilder<Entity extends Model<Entity, Partial<Entity>>> {
+    readonly model: ModelCtor<Entity>;
+    static convertToAggregateResponse<Entity>(rawAggregates: Record<string, unknown>[]): AggregateResponse<Entity>[];
+    constructor(model: ModelCtor<Entity>);
+    /**
+     * Builds a aggregate SELECT clause from a aggregate.
+     * @param aggregate - the aggregates to select.
+     */
+    build(aggregate: AggregateQuery<Entity>): Projectable;
+    private createAggSelect;
+    private createGroupBySelect;
+}

package/src/query/aggregate.builder.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AggregateBuilder = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const camel_case_1 = require("camel-case");
+const sequelize_1 = (0, tslib_1.__importDefault)(require("sequelize"));
+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 {
+    constructor(model) {
+        this.model = model;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    static convertToAggregateResponse(rawAggregates) {
+        return rawAggregates.map((aggregate) => {
+            return Object.keys(aggregate).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 aggResponseKey = (0, camel_case_1.camelCase)(matchedFunc.toLowerCase());
+                const fieldName = matchedFieldName;
+                const aggResult = agg[aggResponseKey] || {};
+                return {
+                    ...agg,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    [aggResponseKey]: { ...aggResult, [fieldName]: aggregate[resultField] }
+                };
+            }, {});
+        });
+    }
+    /**
+     * Builds a aggregate SELECT clause from a aggregate.
+     * @param aggregate - the aggregates to select.
+     */
+    build(aggregate) {
+        const selects = [
+            ...this.createGroupBySelect(aggregate.groupBy),
+            ...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 (!selects.length) {
+            throw new common_1.BadRequestException('No aggregate fields found.');
+        }
+        return {
+            attributes: selects
+        };
+    }
+    createAggSelect(func, fields) {
+        if (!fields) {
+            return [];
+        }
+        return fields.map((field) => {
+            const aggAlias = `${func}_${field}`;
+            const colName = this.model.rawAttributes[field].field;
+            const fn = sequelize_1.default.fn(func, sequelize_1.default.col(colName || field));
+            return [fn, aggAlias];
+        });
+    }
+    createGroupBySelect(fields) {
+        if (!fields) {
+            return [];
+        }
+        return fields.map((field) => {
+            const colName = this.model.rawAttributes[field].field;
+            return [sequelize_1.default.col(colName || field), `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-sequelize/src/query/aggregate.builder.ts"],"names":[],"mappings":";;;;AAAA,2CAAoD;AAEpD,2CAAsC;AACtC,uEAAkD;AAGlD,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;AAED,MAAM,UAAU,GAAG,uCAAuC,CAAA;AAE1D;;;GAGG;AACH,MAAa,gBAAgB;IAsB3B,YAAqB,KAAwB;QAAxB,UAAK,GAAL,KAAK,CAAmB;IAAG,CAAC;IArBjD,wDAAwD;IACxD,MAAM,CAAC,0BAA0B,CAAS,aAAwC;QAChF,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;YACrC,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,WAAmB,EAAE,EAAE;gBAChE,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAChD,IAAI,CAAC,WAAW,EAAE;oBAChB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;iBACzD;gBACD,MAAM,CAAC,WAAW,EAAE,gBAAgB,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAC5D,MAAM,cAAc,GAAG,IAAA,sBAAS,EAAC,WAAW,CAAC,WAAW,EAAE,CAAoC,CAAA;gBAC9F,MAAM,SAAS,GAAG,gBAAgC,CAAA;gBAClD,MAAM,SAAS,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAA;gBAC3C,OAAO;oBACL,GAAG,GAAG;oBACN,mEAAmE;oBACnE,CAAC,cAAc,CAAC,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,EAAE;iBACxE,CAAA;YACH,CAAC,EAAE,EAA+B,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;IACJ,CAAC;IAID;;;OAGG;IACH,KAAK,CAAC,SAAiC;QACrC,MAAM,OAAO,GAAG;YACd,GAAG,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,OAAO,CAAC;YAC9C,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,OAAO,CAAC,MAAM,EAAE;YACnB,MAAM,IAAI,4BAAmB,CAAC,4BAA4B,CAAC,CAAA;SAC5D;QACD,OAAO;YACL,UAAU,EAAE,OAAO;SACpB,CAAA;IACH,CAAC;IAEO,eAAe,CAAC,IAAoB,EAAE,MAAyB;QACrE,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,EAAE,CAAA;SACV;QACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1B,MAAM,QAAQ,GAAG,GAAG,IAAI,IAAI,KAAe,EAAE,CAAA;YAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAe,CAAC,CAAC,KAAK,CAAA;YAC/D,MAAM,EAAE,GAAG,mBAAS,CAAC,EAAE,CAAC,IAAI,EAAE,mBAAS,CAAC,GAAG,CAAC,OAAO,IAAK,KAAgB,CAAC,CAAC,CAAA;YAC1E,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,mBAAmB,CAAC,MAAyB;QACnD,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,EAAE,CAAA;SACV;QACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAe,CAAC,CAAC,KAAK,CAAA;YAC/D,OAAO,CAAC,mBAAS,CAAC,GAAG,CAAC,OAAO,IAAK,KAAgB,CAAC,EAAE,YAAY,KAAe,EAAE,CAAC,CAAA;QACrF,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAlED,4CAkEC"}

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

@@ -0,0 +1,96 @@
+import { AggregateQuery, Filter, Paging, Query, SortField } from '@ptc-org/nestjs-query-core';
+import { CountOptions, DestroyOptions, Filterable, FindOptions, GroupOption, Order, UpdateOptions } from 'sequelize';
+import { Model, ModelCtor } from 'sequelize-typescript';
+import { AggregateBuilder } from './aggregate.builder';
+import { WhereBuilder } from './where.builder';
+/**
+ * @internal
+ *
+ * Interface that for `sequelize` query builders that are sortable.
+ */
+interface Sortable {
+    order?: Order;
+}
+/**
+ * @internal
+ *
+ * Interface for `sequelize` query builders that are pageable.
+ */
+interface Pageable {
+    limit?: number;
+    offset?: number;
+}
+interface Groupable {
+    group?: GroupOption;
+}
+/**
+ * @internal
+ *
+ * Class that will convert a Query into a `sequelize` Query Builder.
+ */
+export declare class FilterQueryBuilder<Entity extends Model<Entity, Partial<Entity>>> {
+    readonly model: ModelCtor<Entity>;
+    readonly whereBuilder: WhereBuilder<Entity>;
+    readonly aggregateBuilder: AggregateBuilder<Entity>;
+    constructor(model: ModelCtor<Entity>, whereBuilder?: WhereBuilder<Entity>, aggregateBuilder?: AggregateBuilder<Entity>);
+    /**
+     * Create a `sequelize` SelectQueryBuilder with `WHERE`, `ORDER BY` and `LIMIT/OFFSET` clauses.
+     *
+     * @param query - the query to apply.
+     */
+    findOptions(query: Query<Entity>): FindOptions;
+    /**
+     * Create a `sequelize` SelectQueryBuilder with `WHERE`, `ORDER BY` and `LIMIT/OFFSET` clauses.
+     *
+     * @param pk - The primary key(s) of records to find.
+     * @param query - the query to apply.
+     */
+    findByIdOptions(pk: string | number | (string | number)[], query: Query<Entity>): FindOptions;
+    /**
+     * Create a `sequelize` SelectQueryBuilder with `WHERE`, `ORDER BY` and `LIMIT/OFFSET` clauses.
+     *
+     * @param query - the query to apply.
+     * @param aggregate - the aggregate query
+     */
+    aggregateOptions(query: Query<Entity>, aggregate: AggregateQuery<Entity>): FindOptions;
+    relationAggregateOptions(query: Query<Entity>, aggregate: AggregateQuery<Entity>): FindOptions;
+    countOptions(query: Query<Entity>): CountOptions<Entity>;
+    /**
+     * Create a `sequelize` DeleteQueryBuilder with a WHERE clause.
+     *
+     * @param query - the query to apply.
+     */
+    destroyOptions(query: Query<Entity>): DestroyOptions;
+    /**
+     * Create a `sequelize` UpdateQueryBuilder with `WHERE` and `ORDER BY` clauses
+     *
+     * @param query - the query to apply.
+     */
+    updateOptions(query: Query<Entity>): UpdateOptions<Entity['_attributes']>;
+    /**
+     * Applies paging to a Pageable `sequelize` query builder
+     * @param qb - the `sequelize` QueryBuilder
+     * @param paging - the Paging options.
+     */
+    applyPaging<P extends Pageable>(qb: P, paging?: Paging): P;
+    /**
+     * Applies the filter from a Query to a `sequelize` QueryBuilder.
+     *
+     * @param filterable - the `sequelize` QueryBuilder.
+     * @param filter - the filter.
+     */
+    applyFilter<Where extends Filterable>(filterable: Where, filter?: Filter<Entity>): Where;
+    /**
+     * Applies the ORDER BY clause to a `sequelize` QueryBuilder.
+     * @param qb - the `sequelize` QueryBuilder.
+     * @param sorts - an array of SortFields to create the ORDER BY clause.
+     */
+    applySorting<T extends Sortable>(qb: T, sorts?: SortField<Entity>[]): T;
+    private applyAggregate;
+    applyGroupBy<T extends Groupable>(qb: T, groupBy?: (keyof Entity)[]): T;
+    applyAggregateSorting<T extends Sortable>(qb: T, groupBy?: (keyof Entity)[]): T;
+    private applyAssociationIncludes;
+    private getReferencedRelations;
+    private get relationNames();
+}
+export {};

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

@@ -0,0 +1,203 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterQueryBuilder = void 0;
+const tslib_1 = require("tslib");
+const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
+const sequelize_1 = (0, tslib_1.__importDefault)(require("sequelize"));
+const aggregate_builder_1 = require("./aggregate.builder");
+const where_builder_1 = require("./where.builder");
+/**
+ * @internal
+ *
+ * Class that will convert a Query into a `sequelize` Query Builder.
+ */
+class FilterQueryBuilder {
+    constructor(model, whereBuilder = new where_builder_1.WhereBuilder(), aggregateBuilder = new aggregate_builder_1.AggregateBuilder(model)) {
+        this.model = model;
+        this.whereBuilder = whereBuilder;
+        this.aggregateBuilder = aggregateBuilder;
+    }
+    /**
+     * Create a `sequelize` SelectQueryBuilder with `WHERE`, `ORDER BY` and `LIMIT/OFFSET` clauses.
+     *
+     * @param query - the query to apply.
+     */
+    findOptions(query) {
+        let opts = this.applyAssociationIncludes({ subQuery: false }, query.filter);
+        opts = this.applyFilter(opts, query.filter);
+        opts = this.applySorting(opts, query.sorting);
+        opts = this.applyPaging(opts, query.paging);
+        return opts;
+    }
+    /**
+     * Create a `sequelize` SelectQueryBuilder with `WHERE`, `ORDER BY` and `LIMIT/OFFSET` clauses.
+     *
+     * @param pk - The primary key(s) of records to find.
+     * @param query - the query to apply.
+     */
+    findByIdOptions(pk, query) {
+        let opts = this.applyAssociationIncludes({ subQuery: false }, query.filter);
+        opts = this.applyFilter(opts, {
+            ...(query.filter ?? {}),
+            [this.model.primaryKeyAttribute]: { [Array.isArray(pk) ? 'in' : 'eq']: pk }
+        });
+        opts = this.applySorting(opts, query.sorting);
+        opts = this.applyPaging(opts, query.paging);
+        return opts;
+    }
+    /**
+     * Create a `sequelize` SelectQueryBuilder with `WHERE`, `ORDER BY` and `LIMIT/OFFSET` clauses.
+     *
+     * @param query - the query to apply.
+     * @param aggregate - the aggregate query
+     */
+    aggregateOptions(query, aggregate) {
+        let opts = { raw: true };
+        opts = this.applyAggregate(opts, aggregate);
+        opts = this.applyFilter(opts, query.filter);
+        opts = this.applyAggregateSorting(opts, aggregate.groupBy);
+        opts = this.applyGroupBy(opts, aggregate.groupBy);
+        return opts;
+    }
+    relationAggregateOptions(query, aggregate) {
+        // joinTableAttributes is used by many-to-many relations and must be empty.
+        let opts = { joinTableAttributes: [], raw: true };
+        opts = this.applyAggregate(opts, aggregate);
+        opts = this.applyFilter(opts, query.filter);
+        opts = this.applyAggregateSorting(opts, aggregate.groupBy);
+        opts = this.applyGroupBy(opts, aggregate.groupBy);
+        return opts;
+    }
+    countOptions(query) {
+        let opts = this.applyAssociationIncludes({}, query.filter);
+        opts.distinct = true;
+        opts = this.applyFilter(opts, query.filter);
+        return opts;
+    }
+    /**
+     * Create a `sequelize` DeleteQueryBuilder with a WHERE clause.
+     *
+     * @param query - the query to apply.
+     */
+    destroyOptions(query) {
+        let opts = {};
+        opts = this.applyFilter(opts, query.filter);
+        opts = this.applyPaging(opts, query.paging);
+        return opts;
+    }
+    /**
+     * Create a `sequelize` UpdateQueryBuilder with `WHERE` and `ORDER BY` clauses
+     *
+     * @param query - the query to apply.
+     */
+    updateOptions(query) {
+        let opts = { where: {} };
+        opts = this.applyFilter(opts, query.filter);
+        opts = this.applyPaging(opts, query.paging);
+        return opts;
+    }
+    /**
+     * Applies paging to a Pageable `sequelize` query builder
+     * @param qb - the `sequelize` QueryBuilder
+     * @param paging - the Paging options.
+     */
+    applyPaging(qb, paging) {
+        if (!paging) {
+            return qb;
+        }
+        if (paging.limit !== undefined) {
+            // eslint-disable-next-line no-param-reassign
+            qb.limit = paging.limit;
+        }
+        if (paging.offset !== undefined) {
+            // eslint-disable-next-line no-param-reassign
+            qb.offset = paging.offset;
+        }
+        return qb;
+    }
+    /**
+     * Applies the filter from a Query to a `sequelize` QueryBuilder.
+     *
+     * @param filterable - the `sequelize` QueryBuilder.
+     * @param filter - the filter.
+     */
+    applyFilter(filterable, filter) {
+        if (!filter) {
+            return filterable;
+        }
+        // eslint-disable-next-line no-param-reassign
+        filterable.where = this.whereBuilder.build(filter, this.getReferencedRelations(filter));
+        return filterable;
+    }
+    /**
+     * Applies the ORDER BY clause to a `sequelize` QueryBuilder.
+     * @param qb - the `sequelize` QueryBuilder.
+     * @param sorts - an array of SortFields to create the ORDER BY clause.
+     */
+    applySorting(qb, sorts) {
+        if (!sorts) {
+            return qb;
+        }
+        // eslint-disable-next-line no-param-reassign
+        qb.order = sorts.map(({ field, direction, nulls }) => {
+            const col = `${field}`;
+            const dir = [direction];
+            if (nulls) {
+                dir.push(nulls);
+            }
+            return [col, dir.join(' ')];
+        });
+        return qb;
+    }
+    applyAggregate(opts, aggregate) {
+        // eslint-disable-next-line no-param-reassign
+        opts.attributes = this.aggregateBuilder.build(aggregate).attributes;
+        return opts;
+    }
+    applyGroupBy(qb, groupBy) {
+        if (!groupBy) {
+            return qb;
+        }
+        // eslint-disable-next-line no-param-reassign
+        qb.group = groupBy.map((field) => {
+            const colName = this.model.rawAttributes[field].field;
+            return sequelize_1.default.col(colName ?? field);
+        });
+        return qb;
+    }
+    applyAggregateSorting(qb, groupBy) {
+        if (!groupBy) {
+            return qb;
+        }
+        // eslint-disable-next-line no-param-reassign
+        qb.order = groupBy.map((field) => {
+            const colName = this.model.rawAttributes[field].field;
+            const col = sequelize_1.default.col(colName ?? field);
+            return [col, 'ASC'];
+        });
+        return qb;
+    }
+    applyAssociationIncludes(findOpts, filter) {
+        if (!filter) {
+            return findOpts;
+        }
+        const referencedRelations = this.getReferencedRelations(filter);
+        return [...referencedRelations.values()].reduce((find, association) => {
+            const { include = [] } = find;
+            // eslint-disable-next-line no-param-reassign
+            find.include = [...(Array.isArray(include) ? include : [include]), { association, attributes: [] }];
+            return find;
+        }, findOpts);
+    }
+    getReferencedRelations(filter) {
+        const { relationNames } = this;
+        const referencedFields = (0, nestjs_query_core_1.getFilterFields)(filter);
+        const referencedRelations = referencedFields.filter((f) => relationNames.includes(f));
+        return referencedRelations.reduce((map, r) => map.set(r, this.model.associations[r]), new Map());
+    }
+    get relationNames() {
+        return Object.keys(this.model.associations || {});
+    }
+}
+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-sequelize/src/query/filter-query.builder.ts"],"names":[],"mappings":";;;;AAAA,kEAA8G;AAC9G,uEAWkB;AAGlB,2DAAsD;AACtD,mDAA8C;AAyB9C;;;;GAIG;AACH,MAAa,kBAAkB;IAC7B,YACW,KAAwB,EACxB,eAAqC,IAAI,4BAAY,EAAU,EAC/D,mBAA6C,IAAI,oCAAgB,CAAS,KAAK,CAAC;QAFhF,UAAK,GAAL,KAAK,CAAmB;QACxB,iBAAY,GAAZ,YAAY,CAAmD;QAC/D,qBAAgB,GAAhB,gBAAgB,CAAgE;IACxF,CAAC;IAEJ;;;;OAIG;IACH,WAAW,CAAC,KAAoB;QAC9B,IAAI,IAAI,GAAgB,IAAI,CAAC,wBAAwB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QACxF,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3C,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;QAC7C,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3C,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,EAAyC,EAAE,KAAoB;QAC7E,IAAI,IAAI,GAAgB,IAAI,CAAC,wBAAwB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QACxF,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;YAC5B,GAAG,CAAC,KAAK,CAAC,MAAM,IAAK,EAAqB,CAAC;YAC3C,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE;SAC5E,CAAC,CAAA;QACF,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;QAC7C,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3C,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,KAAoB,EAAE,SAAiC;QACtE,IAAI,IAAI,GAAgB,EAAE,GAAG,EAAE,IAAI,EAAE,CAAA;QACrC,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;QAC3C,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3C,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QAC1D,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QACjD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,wBAAwB,CAAC,KAAoB,EAAE,SAAiC;QAC9E,2EAA2E;QAC3E,IAAI,IAAI,GAAgB,EAAE,mBAAmB,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAiB,CAAA;QAC7E,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;QAC3C,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3C,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QAC1D,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QACjD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,YAAY,CAAC,KAAoB;QAC/B,IAAI,IAAI,GAAiB,IAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QACxE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3C,OAAO,IAA4B,CAAA;IACrC,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,KAAoB;QACjC,IAAI,IAAI,GAAmB,EAAE,CAAA;QAC7B,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3C,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3C,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,KAAoB;QAChC,IAAI,IAAI,GAA0B,EAAE,KAAK,EAAE,EAAE,EAAE,CAAA;QAC/C,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3C,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3C,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAqB,EAAK,EAAE,MAAe;QACpD,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,EAAE,CAAA;SACV;QACD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;YAC9B,6CAA6C;YAC7C,EAAE,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;SACxB;QACD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;YAC/B,6CAA6C;YAC7C,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;SAC1B;QACD,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAA2B,UAAiB,EAAE,MAAuB;QAC9E,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,UAAU,CAAA;SAClB;QACD,6CAA6C;QAC7C,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAA;QACvF,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAqB,EAAK,EAAE,KAA2B;QACjE,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,EAAE,CAAA;SACV;QACD,6CAA6C;QAC7C,EAAE,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,EAAa,EAAE;YAC9D,MAAM,GAAG,GAAG,GAAG,KAAe,EAAE,CAAA;YAChC,MAAM,GAAG,GAAa,CAAC,SAAS,CAAC,CAAA;YACjC,IAAI,KAAK,EAAE;gBACT,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;aAChB;YACD,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;QAC7B,CAAC,CAAC,CAAA;QACF,OAAO,EAAE,CAAA;IACX,CAAC;IAEO,cAAc,CAAwB,IAAO,EAAE,SAAiC;QACtF,6CAA6C;QAC7C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,UAAU,CAAA;QACnE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,YAAY,CAAsB,EAAK,EAAE,OAA0B;QACjE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,EAAE,CAAA;SACV;QACD,6CAA6C;QAC7C,EAAE,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAe,CAAC,CAAC,KAAK,CAAA;YAC/D,OAAO,mBAAS,CAAC,GAAG,CAAC,OAAO,IAAK,KAAgB,CAAC,CAAA;QACpD,CAAC,CAAC,CAAA;QACF,OAAO,EAAE,CAAA;IACX,CAAC;IAED,qBAAqB,CAAqB,EAAK,EAAE,OAA0B;QACzE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,EAAE,CAAA;SACV;QACD,6CAA6C;QAC7C,EAAE,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAa,EAAE;YAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAe,CAAC,CAAC,KAAK,CAAA;YAC/D,MAAM,GAAG,GAAG,mBAAS,CAAC,GAAG,CAAC,OAAO,IAAK,KAAgB,CAAC,CAAA;YACvD,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACrB,CAAC,CAAC,CAAA;QACF,OAAO,EAAE,CAAA;IACX,CAAC;IAEO,wBAAwB,CAC9B,QAAc,EACd,MAAuB;QAEvB,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,QAAQ,CAAA;SAChB;QACD,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAA;QAC/D,OAAO,CAAC,GAAG,mBAAmB,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE;YACpE,MAAM,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,IAAI,CAAA;YAC7B,6CAA6C;YAC7C,IAAI,CAAC,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAA;YACnG,OAAO,IAAI,CAAA;QACb,CAAC,EAAE,QAAQ,CAAC,CAAA;IACd,CAAC;IAEO,sBAAsB,CAAC,MAAsB;QACnD,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,CAAA;QAC9B,MAAM,gBAAgB,GAAG,IAAA,mCAAe,EAAC,MAAM,CAAC,CAAA;QAChD,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QACrF,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG,EAAuB,CAAC,CAAA;IACvH,CAAC;IAED,IAAY,aAAa;QACvB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,EAAE,CAAC,CAAA;IACnD,CAAC;CACF;AA9MD,gDA8MC"}

package/src/query/index.d.ts

@@ -0,0 +1,4 @@
+export * from './aggregate.builder';
+export * from './filter-query.builder';
+export * from './sql-comparison.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("./filter-query.builder"), exports);
+(0, tslib_1.__exportStar)(require("./sql-comparison.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-sequelize/src/query/index.ts"],"names":[],"mappings":";;;AAAA,mEAAmC;AACnC,sEAAsC;AACtC,wEAAwC;AACxC,+DAA+B"}

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

@@ -0,0 +1,26 @@
+import { CommonFieldComparisonBetweenType, FilterComparisonOperators } from '@ptc-org/nestjs-query-core';
+import { WhereOptions } from 'sequelize';
+/**
+ * @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 SQLComparisonBuilder<Entity> {
+    readonly comparisonMap: Record<string, symbol>;
+    static DEFAULT_COMPARISON_MAP: Record<string, symbol>;
+    constructor(comparisonMap?: Record<string, symbol>);
+    /**
+     * 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>, alias?: string): WhereOptions;
+    private betweenComparisonSQL;
+    private notBetweenComparisonSQL;
+    private isBetweenVal;
+}