@ptc-org/nestjs-query-typeorm 0.32.0 → 0.32.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptc-org/nestjs-query-typeorm",
-  "version": "0.32.0",
+  "version": "0.32.1",
   "description": "Typeorm adapter for @nestjs-query/core",
   "author": "doug-martin <doug@dougamartin.com>",
   "homepage": "https://github.com/doug-martin/nestjs-query#readme",
@@ -12,7 +12,7 @@
     "test": "__tests__"
   },
   "files": [
-    "dist/src/**"
+    "src/**"
   ],
   "publishConfig": {
     "access": "public"
@@ -30,7 +30,7 @@
     "@nestjs/typeorm": "^8.0.0",
     "class-transformer": "^0.2.3 || 0.3.1 || 0.4",
     "typeorm": "^0.2.25",
-    "@ptc-org/nestjs-query-core": "0.30.1"
+    "@ptc-org/nestjs-query-core": "0.30.2"
   },
   "devDependencies": {
     "@nestjs/common": "8.4.0",

package/src/common/index.d.ts

@@ -0,0 +1 @@
+export * from './randomString';

package/src/common/index.js

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

package/src/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/query-typeorm/src/common/index.ts"],"names":[],"mappings":";;;AAAA,8DAA+B"}

package/src/common/randomString.d.ts

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

package/src/common/randomString.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.randomString = void 0;
+const uuid_1 = require("uuid");
+const replacer = /-/g;
+function randomString() {
+    return (0, uuid_1.v4)().replace(replacer, '');
+}
+exports.randomString = randomString;
+//# sourceMappingURL=randomString.js.map

package/src/common/randomString.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"randomString.js","sourceRoot":"","sources":["../../../../../packages/query-typeorm/src/common/randomString.ts"],"names":[],"mappings":";;;AAAA,+BAA0B;AAE1B,MAAM,QAAQ,GAAG,IAAI,CAAC;AAEtB,SAAgB,YAAY;IAC1B,OAAO,IAAA,SAAE,GAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AACpC,CAAC;AAFD,oCAEC"}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export { TypeOrmQueryService, TypeOrmQueryServiceOpts } from './services';
+export { NestjsQueryTypeOrmModule } from './module';

package/src/index.js

@@ -1,5 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./lib/query-typeorm"), exports);
+exports.NestjsQueryTypeOrmModule = exports.TypeOrmQueryService = void 0;
+var services_1 = require("./services");
+Object.defineProperty(exports, "TypeOrmQueryService", { enumerable: true, get: function () { return services_1.TypeOrmQueryService; } });
+var module_1 = require("./module");
+Object.defineProperty(exports, "NestjsQueryTypeOrmModule", { enumerable: true, get: function () { return module_1.NestjsQueryTypeOrmModule; } });
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/query-typeorm/src/index.ts"],"names":[],"mappings":";;;AAAA,uCAA0E;AAAjE,+GAAA,mBAAmB,OAAA;AAC5B,mCAAoD;AAA3C,kHAAA,wBAAwB,OAAA"}

package/src/lib/query-typeorm.d.ts

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

package/src/lib/query-typeorm.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.queryTypeorm = void 0;
+function queryTypeorm() {
+    return 'query-typeorm';
+}
+exports.queryTypeorm = queryTypeorm;
+//# sourceMappingURL=query-typeorm.js.map

package/src/lib/query-typeorm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-typeorm.js","sourceRoot":"","sources":["../../../../../packages/query-typeorm/src/lib/query-typeorm.ts"],"names":[],"mappings":";;;AAAA,SAAgB,YAAY;IAC1B,OAAO,eAAe,CAAC;AACzB,CAAC;AAFD,oCAEC"}

package/src/module.d.ts

@@ -0,0 +1,6 @@
+import { Class } from '@ptc-org/nestjs-query-core';
+import { DynamicModule } from '@nestjs/common';
+import { Connection, ConnectionOptions } from 'typeorm';
+export declare class NestjsQueryTypeOrmModule {
+    static forFeature(entities: Class<unknown>[], connection?: Connection | ConnectionOptions | string): DynamicModule;
+}

package/src/module.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NestjsQueryTypeOrmModule = void 0;
+const typeorm_1 = require("@nestjs/typeorm");
+const providers_1 = require("./providers");
+class NestjsQueryTypeOrmModule {
+    static forFeature(entities, connection) {
+        const queryServiceProviders = (0, providers_1.createTypeOrmQueryServiceProviders)(entities, connection);
+        const typeOrmModule = typeorm_1.TypeOrmModule.forFeature(entities, connection);
+        return {
+            imports: [typeOrmModule],
+            module: NestjsQueryTypeOrmModule,
+            providers: [...queryServiceProviders],
+            exports: [...queryServiceProviders, typeOrmModule],
+        };
+    }
+}
+exports.NestjsQueryTypeOrmModule = NestjsQueryTypeOrmModule;
+//# sourceMappingURL=module.js.map

package/src/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../../../packages/query-typeorm/src/module.ts"],"names":[],"mappings":";;;AACA,6CAAgD;AAGhD,2CAAiE;AAEjE,MAAa,wBAAwB;IACnC,MAAM,CAAC,UAAU,CAAC,QAA0B,EAAE,UAAoD;QAChG,MAAM,qBAAqB,GAAG,IAAA,8CAAkC,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACvF,MAAM,aAAa,GAAG,uBAAa,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACrE,OAAO;YACL,OAAO,EAAE,CAAC,aAAa,CAAC;YACxB,MAAM,EAAE,wBAAwB;YAChC,SAAS,EAAE,CAAC,GAAG,qBAAqB,CAAC;YACrC,OAAO,EAAE,CAAC,GAAG,qBAAqB,EAAE,aAAa,CAAC;SACnD,CAAC;IACJ,CAAC;CACF;AAXD,4DAWC"}

package/src/providers.d.ts

@@ -0,0 +1,4 @@
+import { Class } from '@ptc-org/nestjs-query-core';
+import { FactoryProvider } from '@nestjs/common';
+import { Connection, ConnectionOptions } from 'typeorm';
+export declare const createTypeOrmQueryServiceProviders: (entities: Class<unknown>[], connection?: Connection | ConnectionOptions | string) => FactoryProvider[];

package/src/providers.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTypeOrmQueryServiceProviders = void 0;
+const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
+const typeorm_1 = require("@nestjs/typeorm");
+const services_1 = require("./services");
+function createTypeOrmQueryServiceProvider(EntityClass, connection) {
+    return {
+        provide: (0, nestjs_query_core_1.getQueryServiceToken)(EntityClass),
+        useFactory(repo) {
+            return new services_1.TypeOrmQueryService(repo);
+        },
+        inject: [(0, typeorm_1.getRepositoryToken)(EntityClass, connection)],
+    };
+}
+const createTypeOrmQueryServiceProviders = (entities, connection) => entities.map((entity) => createTypeOrmQueryServiceProvider(entity, connection));
+exports.createTypeOrmQueryServiceProviders = createTypeOrmQueryServiceProviders;
+//# sourceMappingURL=providers.js.map

package/src/providers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.js","sourceRoot":"","sources":["../../../../packages/query-typeorm/src/providers.ts"],"names":[],"mappings":";;;AAAA,kEAAyE;AAEzE,6CAAqD;AAErD,yCAAiD;AAEjD,SAAS,iCAAiC,CACxC,WAA0B,EAC1B,UAAoD;IAEpD,OAAO;QACL,OAAO,EAAE,IAAA,wCAAoB,EAAC,WAAW,CAAC;QAC1C,UAAU,CAAC,IAAwB;YACjC,OAAO,IAAI,8BAAmB,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QACD,MAAM,EAAE,CAAC,IAAA,4BAAkB,EAAC,WAAW,EAAE,UAAU,CAAC,CAAC;KACtD,CAAC;AACJ,CAAC;AAEM,MAAM,kCAAkC,GAAG,CAChD,QAA0B,EAC1B,UAAoD,EACjC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCAAiC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;AAH3F,QAAA,kCAAkC,sCAGyD"}

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

@@ -0,0 +1,32 @@
+import { SelectQueryBuilder } from 'typeorm';
+import { AggregateQuery, AggregateResponse } from '@ptc-org/nestjs-query-core';
+declare enum AggregateFuncs {
+    AVG = "AVG",
+    SUM = "SUM",
+    COUNT = "COUNT",
+    MAX = "MAX",
+    MIN = "MIN"
+}
+/**
+ * @internal
+ * Builds a WHERE clause from a Filter.
+ */
+export declare class AggregateBuilder<Entity> {
+    static asyncConvertToAggregateResponse<Entity>(responsePromise: Promise<Record<string, unknown>[]>): Promise<AggregateResponse<Entity>[]>;
+    static getAggregateSelects<Entity>(query: AggregateQuery<Entity>): string[];
+    private static getAggregateGroupBySelects;
+    private static getAggregateFuncSelects;
+    static getAggregateAlias<Entity>(func: AggregateFuncs, field: keyof Entity): string;
+    static getGroupByAlias<Entity>(field: keyof Entity): string;
+    static convertToAggregateResponse<Entity>(rawAggregates: Record<string, unknown>[]): AggregateResponse<Entity>[];
+    /**
+     * Builds a aggregate SELECT clause from a aggregate.
+     * @param qb - the `typeorm` SelectQueryBuilder
+     * @param aggregate - the aggregates to select.
+     * @param alias - optional alias to use to qualify an identifier
+     */
+    build<Qb extends SelectQueryBuilder<Entity>>(qb: Qb, aggregate: AggregateQuery<Entity>, alias?: string): Qb;
+    private createAggSelect;
+    private createGroupBySelect;
+}
+export {};

package/src/query/aggregate.builder.js

@@ -0,0 +1,116 @@
+"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");
+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 async asyncConvertToAggregateResponse(responsePromise) {
+        const aggResponse = await responsePromise;
+        return this.convertToAggregateResponse(aggResponse);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    static getAggregateSelects(query) {
+        return [...this.getAggregateGroupBySelects(query), ...this.getAggregateFuncSelects(query)];
+    }
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    static getAggregateGroupBySelects(query) {
+        return (query.groupBy ?? []).map((f) => this.getGroupByAlias(f));
+    }
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    static getAggregateFuncSelects(query) {
+        const aggs = [
+            [AggregateFuncs.COUNT, query.count],
+            [AggregateFuncs.SUM, query.sum],
+            [AggregateFuncs.AVG, query.avg],
+            [AggregateFuncs.MAX, query.max],
+            [AggregateFuncs.MIN, query.min],
+        ];
+        return aggs.reduce((cols, [func, fields]) => {
+            const aliases = (fields ?? []).map((f) => this.getAggregateAlias(func, f));
+            return [...cols, ...aliases];
+        }, []);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    static getAggregateAlias(func, field) {
+        return `${func}_${field}`;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    static getGroupByAlias(field) {
+        return `GROUP_BY_${field}`;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    static convertToAggregateResponse(rawAggregates) {
+        return rawAggregates.map((response) => {
+            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 qb - the `typeorm` SelectQueryBuilder
+     * @param aggregate - the aggregates to select.
+     * @param alias - optional alias to use to qualify an identifier
+     */
+    build(qb, aggregate, alias) {
+        const selects = [
+            ...this.createGroupBySelect(aggregate.groupBy, alias),
+            ...this.createAggSelect(AggregateFuncs.COUNT, aggregate.count, alias),
+            ...this.createAggSelect(AggregateFuncs.SUM, aggregate.sum, alias),
+            ...this.createAggSelect(AggregateFuncs.AVG, aggregate.avg, alias),
+            ...this.createAggSelect(AggregateFuncs.MAX, aggregate.max, alias),
+            ...this.createAggSelect(AggregateFuncs.MIN, aggregate.min, alias),
+        ];
+        if (!selects.length) {
+            throw new common_1.BadRequestException('No aggregate fields found.');
+        }
+        const [head, ...tail] = selects;
+        return tail.reduce((acc, [select, selectAlias]) => acc.addSelect(select, selectAlias), qb.select(head[0], head[1]));
+    }
+    createAggSelect(func, fields, alias) {
+        if (!fields) {
+            return [];
+        }
+        return fields.map((field) => {
+            const col = alias ? `${alias}.${field}` : field;
+            return [`${func}(${col})`, AggregateBuilder.getAggregateAlias(func, field)];
+        });
+    }
+    createGroupBySelect(fields, alias) {
+        if (!fields) {
+            return [];
+        }
+        return fields.map((field) => {
+            const col = alias ? `${alias}.${field}` : field;
+            return [`${col}`, AggregateBuilder.getGroupByAlias(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-typeorm/src/query/aggregate.builder.ts"],"names":[],"mappings":";;;AAEA,2CAAqD;AACrD,2CAAuC;AAEvC,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,CAAC;AAE3D;;;GAGG;AACH,MAAa,gBAAgB;IAC3B,wDAAwD;IACxD,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAC1C,eAAmD;QAEnD,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC;QAC1C,OAAO,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;IAED,wDAAwD;IACxD,MAAM,CAAC,mBAAmB,CAAS,KAA6B;QAC9D,OAAO,CAAC,GAAG,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED,wDAAwD;IAChD,MAAM,CAAC,0BAA0B,CAAS,KAA6B;QAC7E,OAAO,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,wDAAwD;IAChD,MAAM,CAAC,uBAAuB,CAAS,KAA6B;QAC1E,MAAM,IAAI,GAAqD;YAC7D,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;YACnC,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC;YAC/B,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC;YAC/B,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC;YAC/B,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC;SAChC,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;YAC1C,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAC3E,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC;QAC/B,CAAC,EAAE,EAAc,CAAC,CAAC;IACrB,CAAC;IAED,wDAAwD;IACxD,MAAM,CAAC,iBAAiB,CAAS,IAAoB,EAAE,KAAmB;QACxE,OAAO,GAAG,IAAI,IAAI,KAAe,EAAE,CAAC;IACtC,CAAC;IAED,wDAAwD;IACxD,MAAM,CAAC,eAAe,CAAS,KAAmB;QAChD,OAAO,YAAY,KAAe,EAAE,CAAC;IACvC,CAAC;IAED,wDAAwD;IACxD,MAAM,CAAC,0BAA0B,CAAS,aAAwC;QAChF,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACpC,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,GAA8B,EAAE,WAAmB,EAAE,EAAE;gBAC1F,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACjD,IAAI,CAAC,WAAW,EAAE;oBAChB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;iBAC1D;gBACD,MAAM,CAAC,WAAW,EAAE,gBAAgB,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC7D,MAAM,OAAO,GAAG,IAAA,sBAAS,EAAC,WAAW,CAAC,WAAW,EAAE,CAAoC,CAAC;gBACxF,MAAM,SAAS,GAAG,gBAAgC,CAAC;gBACnD,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBACrC,OAAO;oBACL,GAAG,GAAG;oBACN,mEAAmE;oBACnE,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE;iBAChE,CAAC;YACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAwC,EAAM,EAAE,SAAiC,EAAE,KAAc;QACpG,MAAM,OAAO,GAAG;YACd,GAAG,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC;YACrD,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC;YACrE,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC;YACjE,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC;YACjE,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC;YACjE,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC;SAClE,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACnB,MAAM,IAAI,4BAAmB,CAAC,4BAA4B,CAAC,CAAC;SAC7D;QACD,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC;QAChC,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,GAAO,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC,EACtE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAC5B,CAAC;IACJ,CAAC;IAEO,eAAe,CAAC,IAAoB,EAAE,MAAyB,EAAE,KAAc;QACrF,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,EAAE,CAAC;SACX;QACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1B,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,KAAe,EAAE,CAAC,CAAC,CAAE,KAAgB,CAAC;YACtE,OAAO,CAAC,GAAG,IAAI,IAAI,GAAG,GAAG,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,mBAAmB,CAAC,MAAyB,EAAE,KAAc;QACnE,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,EAAE,CAAC;SACX;QACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1B,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,KAAe,EAAE,CAAC,CAAC,CAAE,KAAgB,CAAC;YACtE,OAAO,CAAC,GAAG,GAAG,EAAE,EAAE,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA7GD,4CA6GC"}

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

@@ -0,0 +1,129 @@
+import { Filter, Paging, Query, SortField, AggregateQuery } from '@ptc-org/nestjs-query-core';
+import { DeleteQueryBuilder, QueryBuilder, Repository, SelectQueryBuilder, UpdateQueryBuilder, WhereExpression, EntityMetadata } from 'typeorm';
+import { SoftDeleteQueryBuilder } from 'typeorm/query-builder/SoftDeleteQueryBuilder';
+import { AggregateBuilder } from './aggregate.builder';
+import { WhereBuilder } from './where.builder';
+/**
+ * @internal
+ *
+ * Interface that for Typeorm query builders that are sortable.
+ */
+interface Sortable<Entity> extends QueryBuilder<Entity> {
+    addOrderBy(sort: string, order?: 'ASC' | 'DESC', nulls?: 'NULLS FIRST' | 'NULLS LAST'): this;
+}
+interface Groupable<Entity> extends QueryBuilder<Entity> {
+    addGroupBy(groupBy: string): this;
+}
+/**
+ * @internal
+ *
+ * Interface for `typeorm` query builders that are pageable.
+ */
+interface Pageable<Entity> extends QueryBuilder<Entity> {
+    limit(limit?: number): this;
+    offset(offset?: number): this;
+    skip(skip?: number): this;
+    take(take?: number): this;
+}
+/**
+ * @internal
+ *
+ * Nested record type
+ */
+export interface NestedRecord<E = unknown> {
+    [keys: string]: NestedRecord<E>;
+}
+/**
+ * @internal
+ *
+ * Class that will convert a Query into a `typeorm` Query Builder.
+ */
+export declare class FilterQueryBuilder<Entity> {
+    readonly repo: Repository<Entity>;
+    readonly whereBuilder: WhereBuilder<Entity>;
+    readonly aggregateBuilder: AggregateBuilder<Entity>;
+    constructor(repo: Repository<Entity>, whereBuilder?: WhereBuilder<Entity>, aggregateBuilder?: AggregateBuilder<Entity>);
+    /**
+     * Create a `typeorm` SelectQueryBuilder with `WHERE`, `ORDER BY` and `LIMIT/OFFSET` clauses.
+     *
+     * @param query - the query to apply.
+     */
+    select(query: Query<Entity>): SelectQueryBuilder<Entity>;
+    selectById(id: string | number | (string | number)[], query: Query<Entity>): SelectQueryBuilder<Entity>;
+    aggregate(query: Query<Entity>, aggregate: AggregateQuery<Entity>): SelectQueryBuilder<Entity>;
+    /**
+     * Create a `typeorm` DeleteQueryBuilder with a WHERE clause.
+     *
+     * @param query - the query to apply.
+     */
+    delete(query: Query<Entity>): DeleteQueryBuilder<Entity>;
+    /**
+     * Create a `typeorm` DeleteQueryBuilder with a WHERE clause.
+     *
+     * @param query - the query to apply.
+     */
+    softDelete(query: Query<Entity>): SoftDeleteQueryBuilder<Entity>;
+    /**
+     * Create a `typeorm` UpdateQueryBuilder with `WHERE` and `ORDER BY` clauses
+     *
+     * @param query - the query to apply.
+     */
+    update(query: Query<Entity>): UpdateQueryBuilder<Entity>;
+    /**
+     * Applies paging to a Pageable `typeorm` query builder
+     * @param qb - the `typeorm` QueryBuilder
+     * @param paging - the Paging options.
+     * @param useSkipTake - if skip/take should be used instead of limit/offset.
+     */
+    applyPaging<P extends Pageable<Entity>>(qb: P, paging?: Paging, useSkipTake?: boolean): P;
+    /**
+     * Applies the filter from a Query to a `typeorm` QueryBuilder.
+     *
+     * @param qb - the `typeorm` QueryBuilder.
+     * @param aggregate - the aggregates to select.
+     * @param alias - optional alias to use to qualify an identifier
+     */
+    applyAggregate<Qb extends SelectQueryBuilder<Entity>>(qb: Qb, aggregate: AggregateQuery<Entity>, alias?: string): Qb;
+    /**
+     * Applies the filter from a Query to a `typeorm` QueryBuilder.
+     *
+     * @param qb - the `typeorm` QueryBuilder.
+     * @param filter - the filter.
+     * @param alias - optional alias to use to qualify an identifier
+     */
+    applyFilter<Where extends WhereExpression>(qb: Where, filter?: Filter<Entity>, alias?: string): Where;
+    /**
+     * Applies the ORDER BY clause to a `typeorm` QueryBuilder.
+     * @param qb - the `typeorm` QueryBuilder.
+     * @param sorts - an array of SortFields to create the ORDER BY clause.
+     * @param alias - optional alias to use to qualify an identifier
+     */
+    applySorting<T extends Sortable<Entity>>(qb: T, sorts?: SortField<Entity>[], alias?: string): T;
+    applyGroupBy<T extends Groupable<Entity>>(qb: T, groupBy?: (keyof Entity)[], alias?: string): T;
+    applyAggregateSorting<T extends Sortable<Entity>>(qb: T, groupBy?: (keyof Entity)[], alias?: string): T;
+    /**
+     * Create a `typeorm` SelectQueryBuilder which can be used as an entry point to create update, delete or insert
+     * QueryBuilders.
+     */
+    private createQueryBuilder;
+    /**
+     * Gets relations referenced in the filter and adds joins for them to the query builder
+     * @param qb - the `typeorm` QueryBuilder.
+     * @param relationsMap - the relations map.
+     *
+     * @returns the query builder for chaining
+     */
+    applyRelationJoinsRecursive(qb: SelectQueryBuilder<Entity>, relationsMap?: NestedRecord, alias?: string): SelectQueryBuilder<Entity>;
+    /**
+     * Checks if a filter references any relations.
+     * @param filter
+     * @private
+     *
+     * @returns true if there are any referenced relations
+     */
+    filterHasRelations(filter?: Filter<Entity>): boolean;
+    private getReferencedRelations;
+    getReferencedRelationsRecursive(metadata: EntityMetadata, filter?: Filter<unknown>): NestedRecord;
+    private get relationNames();
+}
+export {};

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

@@ -0,0 +1,216 @@
+"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 aggregate_builder_1 = require("./aggregate.builder");
+const where_builder_1 = require("./where.builder");
+const lodash_merge_1 = (0, tslib_1.__importDefault)(require("lodash.merge"));
+/**
+ * @internal
+ *
+ * Class that will convert a Query into a `typeorm` Query Builder.
+ */
+class FilterQueryBuilder {
+    constructor(repo, whereBuilder = new where_builder_1.WhereBuilder(), aggregateBuilder = new aggregate_builder_1.AggregateBuilder()) {
+        this.repo = repo;
+        this.whereBuilder = whereBuilder;
+        this.aggregateBuilder = aggregateBuilder;
+    }
+    /**
+     * Create a `typeorm` SelectQueryBuilder with `WHERE`, `ORDER BY` and `LIMIT/OFFSET` clauses.
+     *
+     * @param query - the query to apply.
+     */
+    select(query) {
+        const hasRelations = this.filterHasRelations(query.filter);
+        let qb = this.createQueryBuilder();
+        qb = hasRelations
+            ? this.applyRelationJoinsRecursive(qb, this.getReferencedRelationsRecursive(this.repo.metadata, query.filter))
+            : qb;
+        qb = this.applyFilter(qb, query.filter, qb.alias);
+        qb = this.applySorting(qb, query.sorting, qb.alias);
+        qb = this.applyPaging(qb, query.paging, hasRelations);
+        return qb;
+    }
+    selectById(id, query) {
+        const hasRelations = this.filterHasRelations(query.filter);
+        let qb = this.createQueryBuilder();
+        qb = hasRelations
+            ? this.applyRelationJoinsRecursive(qb, this.getReferencedRelationsRecursive(this.repo.metadata, query.filter))
+            : qb;
+        qb = qb.andWhereInIds(id);
+        qb = this.applyFilter(qb, query.filter, qb.alias);
+        qb = this.applySorting(qb, query.sorting, qb.alias);
+        qb = this.applyPaging(qb, query.paging, hasRelations);
+        return qb;
+    }
+    aggregate(query, aggregate) {
+        let qb = this.createQueryBuilder();
+        qb = this.applyAggregate(qb, aggregate, qb.alias);
+        qb = this.applyFilter(qb, query.filter, qb.alias);
+        qb = this.applyAggregateSorting(qb, aggregate.groupBy, qb.alias);
+        qb = this.applyGroupBy(qb, aggregate.groupBy, qb.alias);
+        return qb;
+    }
+    /**
+     * Create a `typeorm` DeleteQueryBuilder with a WHERE clause.
+     *
+     * @param query - the query to apply.
+     */
+    delete(query) {
+        return this.applyFilter(this.repo.createQueryBuilder().delete(), query.filter);
+    }
+    /**
+     * Create a `typeorm` DeleteQueryBuilder with a WHERE clause.
+     *
+     * @param query - the query to apply.
+     */
+    softDelete(query) {
+        return this.applyFilter(this.repo.createQueryBuilder().softDelete(), query.filter);
+    }
+    /**
+     * Create a `typeorm` UpdateQueryBuilder with `WHERE` and `ORDER BY` clauses
+     *
+     * @param query - the query to apply.
+     */
+    update(query) {
+        const qb = this.applyFilter(this.repo.createQueryBuilder().update(), query.filter);
+        return this.applySorting(qb, query.sorting);
+    }
+    /**
+     * Applies paging to a Pageable `typeorm` query builder
+     * @param qb - the `typeorm` QueryBuilder
+     * @param paging - the Paging options.
+     * @param useSkipTake - if skip/take should be used instead of limit/offset.
+     */
+    applyPaging(qb, paging, useSkipTake) {
+        if (!paging) {
+            return qb;
+        }
+        if (useSkipTake) {
+            return qb.take(paging.limit).skip(paging.offset);
+        }
+        return qb.limit(paging.limit).offset(paging.offset);
+    }
+    /**
+     * Applies the filter from a Query to a `typeorm` QueryBuilder.
+     *
+     * @param qb - the `typeorm` QueryBuilder.
+     * @param aggregate - the aggregates to select.
+     * @param alias - optional alias to use to qualify an identifier
+     */
+    applyAggregate(qb, aggregate, alias) {
+        return this.aggregateBuilder.build(qb, aggregate, alias);
+    }
+    /**
+     * Applies the filter from a Query to a `typeorm` QueryBuilder.
+     *
+     * @param qb - the `typeorm` QueryBuilder.
+     * @param filter - the filter.
+     * @param alias - optional alias to use to qualify an identifier
+     */
+    applyFilter(qb, filter, alias) {
+        if (!filter) {
+            return qb;
+        }
+        return this.whereBuilder.build(qb, filter, this.getReferencedRelationsRecursive(this.repo.metadata, filter), alias);
+    }
+    /**
+     * Applies the ORDER BY clause to a `typeorm` QueryBuilder.
+     * @param qb - the `typeorm` QueryBuilder.
+     * @param sorts - an array of SortFields to create the ORDER BY clause.
+     * @param alias - optional alias to use to qualify an identifier
+     */
+    applySorting(qb, sorts, alias) {
+        if (!sorts) {
+            return qb;
+        }
+        return sorts.reduce((prevQb, { field, direction, nulls }) => {
+            const col = alias ? `${alias}.${field}` : `${field}`;
+            return prevQb.addOrderBy(col, direction, nulls);
+        }, qb);
+    }
+    applyGroupBy(qb, groupBy, alias) {
+        if (!groupBy) {
+            return qb;
+        }
+        return groupBy.reduce((prevQb, group) => {
+            const col = alias ? `${alias}.${group}` : `${group}`;
+            return prevQb.addGroupBy(col);
+        }, qb);
+    }
+    applyAggregateSorting(qb, groupBy, alias) {
+        if (!groupBy) {
+            return qb;
+        }
+        return groupBy.reduce((prevQb, field) => {
+            const col = alias ? `${alias}.${field}` : `${field}`;
+            return prevQb.addOrderBy(col, 'ASC');
+        }, qb);
+    }
+    /**
+     * Create a `typeorm` SelectQueryBuilder which can be used as an entry point to create update, delete or insert
+     * QueryBuilders.
+     */
+    createQueryBuilder() {
+        return this.repo.createQueryBuilder();
+    }
+    /**
+     * Gets relations referenced in the filter and adds joins for them to the query builder
+     * @param qb - the `typeorm` QueryBuilder.
+     * @param relationsMap - the relations map.
+     *
+     * @returns the query builder for chaining
+     */
+    applyRelationJoinsRecursive(qb, relationsMap, alias) {
+        if (!relationsMap) {
+            return qb;
+        }
+        const referencedRelations = Object.keys(relationsMap);
+        return referencedRelations.reduce((rqb, relation) => {
+            return this.applyRelationJoinsRecursive(rqb.leftJoin(`${alias ?? rqb.alias}.${relation}`, relation), relationsMap[relation], relation);
+        }, qb);
+    }
+    /**
+     * Checks if a filter references any relations.
+     * @param filter
+     * @private
+     *
+     * @returns true if there are any referenced relations
+     */
+    filterHasRelations(filter) {
+        if (!filter) {
+            return false;
+        }
+        return this.getReferencedRelations(filter).length > 0;
+    }
+    getReferencedRelations(filter) {
+        const { relationNames } = this;
+        const referencedFields = (0, nestjs_query_core_1.getFilterFields)(filter);
+        return referencedFields.filter((f) => relationNames.includes(f));
+    }
+    getReferencedRelationsRecursive(metadata, filter = {}) {
+        const referencedFields = Array.from(new Set(Object.keys(filter)));
+        return referencedFields.reduce((prev, curr) => {
+            const currFilterValue = filter[curr];
+            if ((curr === 'and' || curr === 'or') && currFilterValue) {
+                for (const subFilter of currFilterValue) {
+                    prev = (0, lodash_merge_1.default)(prev, this.getReferencedRelationsRecursive(metadata, subFilter));
+                }
+            }
+            const referencedRelation = metadata.relations.find((r) => r.propertyName === curr);
+            if (!referencedRelation)
+                return prev;
+            return {
+                ...prev,
+                [curr]: (0, lodash_merge_1.default)(prev[curr], this.getReferencedRelationsRecursive(referencedRelation.inverseEntityMetadata, currFilterValue)),
+            };
+        }, {});
+    }
+    get relationNames() {
+        return this.repo.metadata.relations.map((r) => r.propertyName);
+    }
+}
+exports.FilterQueryBuilder = FilterQueryBuilder;
+//# sourceMappingURL=filter-query.builder.js.map