@ptc-org/nestjs-query-core 0.30.1 → 1.0.0-alpha.1

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

@@ -0,0 +1,50 @@
+import { Class, DeepPartial } from '../common';
+import { Filter, Query, AggregateQuery, AggregateResponse, FindRelationOptions } from '../interfaces';
+import { ProxyQueryService } from './proxy-query.service';
+import { QueryService } from './query.service';
+export declare type QueryServiceRelation<DTO, Relation> = {
+    service: QueryService<Relation, unknown, unknown>;
+    query: (dto: DTO) => Query<Relation>;
+};
+export declare class RelationQueryService<DTO, C = DeepPartial<DTO>, U = DeepPartial<DTO>> extends ProxyQueryService<DTO, C, U> {
+    readonly relations: Record<string, QueryServiceRelation<DTO, unknown>>;
+    constructor(queryService: QueryService<DTO, C, U>, relations: Record<string, QueryServiceRelation<DTO, unknown>>);
+    constructor(relations: Record<string, QueryServiceRelation<DTO, unknown>>);
+    /**
+     * Query for relations for an array of DTOs. This method will return a map with the DTO as the key and the relations as the value.
+     * @param RelationClass - The class of the relation.
+     * @param relationName - The name of the relation to load.
+     * @param dtos - the dtos to find relations for.
+     * @param query - A query to use to filter, page, and sort relations.
+     */
+    queryRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dtos: DTO[], query: Query<Relation>): Promise<Map<DTO, Relation[]>>;
+    /**
+     * Query for an array of relations.
+     * @param RelationClass - The class to serialize the relations into.
+     * @param dto - The dto to query relations for.
+     * @param relationName - The name of relation to query for.
+     * @param query - A query to filter, page and sort relations.
+     */
+    queryRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dto: DTO, query: Query<Relation>): Promise<Relation[]>;
+    aggregateRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dto: DTO, filter: Filter<Relation>, aggregate: AggregateQuery<Relation>): Promise<AggregateResponse<Relation>[]>;
+    aggregateRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dtos: DTO[], filter: Filter<Relation>, aggregate: AggregateQuery<Relation>): Promise<Map<DTO, AggregateResponse<Relation>[]>>;
+    countRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dtos: DTO[], filter: Filter<Relation>): Promise<Map<DTO, number>>;
+    countRelations<Relation>(RelationClass: Class<Relation>, relationName: string, dto: DTO, filter: Filter<Relation>): Promise<number>;
+    /**
+     * Find a relation for an array of DTOs. This will return a Map where the key is the DTO and the value is to relation or undefined if not found.
+     * @param RelationClass - the class of the relation
+     * @param relationName - the name of the relation to load.
+     * @param dtos - the dtos to find the relation for.
+     * @param filter - Additional filter to apply when finding relations
+     */
+    findRelation<Relation>(RelationClass: Class<Relation>, relationName: string, dtos: DTO[], opts?: FindRelationOptions<Relation>): Promise<Map<DTO, Relation | undefined>>;
+    /**
+     * Finds a single relation.
+     * @param RelationClass - The class to serialize the relation into.
+     * @param dto - The dto to find the relation for.
+     * @param relationName - The name of the relation to query for.
+     * @param filter - Additional filter to apply when finding relations
+     */
+    findRelation<Relation>(RelationClass: Class<Relation>, relationName: string, dto: DTO, opts?: FindRelationOptions<Relation>): Promise<Relation | undefined>;
+    getRelation<Relation>(name: string): QueryServiceRelation<DTO, Relation> | undefined;
+}

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

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationQueryService = void 0;
+const helpers_1 = require("../helpers");
+const noop_query_service_1 = require("./noop-query.service");
+const proxy_query_service_1 = require("./proxy-query.service");
+class RelationQueryService extends proxy_query_service_1.ProxyQueryService {
+    constructor(queryService, relations) {
+        if (typeof queryService.query === 'function') {
+            super(queryService);
+            this.relations = relations;
+        }
+        else {
+            super(noop_query_service_1.NoOpQueryService.getInstance());
+            this.relations = queryService;
+        }
+    }
+    async queryRelations(RelationClass, relationName, dto, query) {
+        const serviceRelation = this.getRelation(relationName);
+        if (!serviceRelation) {
+            if (Array.isArray(dto)) {
+                return super.queryRelations(RelationClass, relationName, dto, query);
+            }
+            return super.queryRelations(RelationClass, relationName, dto, query);
+        }
+        const { query: qf, service } = serviceRelation;
+        if (Array.isArray(dto)) {
+            const map = new Map();
+            await Promise.all(dto.map(async (d) => {
+                const relations = await service.query((0, helpers_1.mergeQuery)(query, qf(d)));
+                map.set(d, relations);
+            }));
+            return map;
+        }
+        return service.query((0, helpers_1.mergeQuery)(query, qf(dto)));
+    }
+    async aggregateRelations(RelationClass, relationName, dto, filter, aggregate) {
+        const serviceRelation = this.getRelation(relationName);
+        if (!serviceRelation) {
+            if (Array.isArray(dto)) {
+                return super.aggregateRelations(RelationClass, relationName, dto, filter, aggregate);
+            }
+            return super.aggregateRelations(RelationClass, relationName, dto, filter, aggregate);
+        }
+        const { query: qf, service } = serviceRelation;
+        if (Array.isArray(dto)) {
+            const map = new Map();
+            await Promise.all(dto.map(async (d) => {
+                const relations = await service.aggregate((0, helpers_1.mergeQuery)({ filter }, qf(d)).filter ?? {}, aggregate);
+                map.set(d, relations);
+            }));
+            return map;
+        }
+        return service.aggregate((0, helpers_1.mergeQuery)({ filter }, qf(dto)).filter ?? {}, aggregate);
+    }
+    async countRelations(RelationClass, relationName, dto, filter) {
+        const serviceRelation = this.getRelation(relationName);
+        if (!serviceRelation) {
+            if (Array.isArray(dto)) {
+                return super.countRelations(RelationClass, relationName, dto, filter);
+            }
+            return super.countRelations(RelationClass, relationName, dto, filter);
+        }
+        const { query: qf, service } = serviceRelation;
+        if (Array.isArray(dto)) {
+            const map = new Map();
+            await Promise.all(dto.map(async (d) => {
+                const count = await service.count((0, helpers_1.mergeQuery)({ filter }, qf(d)).filter || {});
+                map.set(d, count);
+            }));
+            return map;
+        }
+        return service.count((0, helpers_1.mergeQuery)({ filter }, qf(dto)).filter || {});
+    }
+    async findRelation(RelationClass, relationName, dto, opts) {
+        const serviceRelation = this.getRelation(relationName);
+        if (!serviceRelation) {
+            if (Array.isArray(dto)) {
+                return super.findRelation(RelationClass, relationName, dto, opts);
+            }
+            return super.findRelation(RelationClass, relationName, dto, opts);
+        }
+        const { query: qf, service } = serviceRelation;
+        if (Array.isArray(dto)) {
+            const map = new Map();
+            await Promise.all(dto.map(async (d) => {
+                const relation = await service.query((0, helpers_1.mergeQuery)(qf(d), { paging: { limit: 1 }, filter: opts?.filter }));
+                map.set(d, relation[0]);
+            }));
+            return map;
+        }
+        return (await service.query((0, helpers_1.mergeQuery)(qf(dto), { paging: { limit: 1 }, filter: opts?.filter })))[0];
+    }
+    getRelation(name) {
+        const relation = this.relations[name];
+        if (relation) {
+            return relation;
+        }
+        return undefined;
+    }
+}
+exports.RelationQueryService = RelationQueryService;
+//# sourceMappingURL=relation-query.service.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"relation-query.service.js","sourceRoot":"","sources":["../../../../../packages/core/src/services/relation-query.service.ts"],"names":[],"mappings":";;;AACA,wCAAwC;AAExC,6DAAwD;AACxD,+DAA0D;AAQ1D,MAAa,oBAAsE,SAAQ,uCAI1F;IAOC,YACE,YAA0F,EAC1F,SAA8D;QAE9D,IAAI,OAAO,YAAY,CAAC,KAAK,KAAK,UAAU,EAAE;YAC5C,KAAK,CAAC,YAAuC,CAAC,CAAC;YAC/C,IAAI,CAAC,SAAS,GAAG,SAA+D,CAAC;SAClF;aAAM;YACL,KAAK,CAAC,qCAAgB,CAAC,WAAW,EAAE,CAAC,CAAC;YACtC,IAAI,CAAC,SAAS,GAAG,YAAkE,CAAC;SACrF;IACH,CAAC;IA8BD,KAAK,CAAC,cAAc,CAClB,aAA8B,EAC9B,YAAoB,EACpB,GAAgB,EAChB,KAAsB;QAEtB,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAW,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,EAAE;YACpB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACtB,OAAO,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;aACtE;YACD,OAAO,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;SACtE;QAED,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,GAAG,GAAG,IAAI,GAAG,EAAmB,CAAC;YACvC,MAAM,OAAO,CAAC,GAAG,CACf,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBAClB,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,IAAA,oBAAU,EAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChE,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;YACxB,CAAC,CAAC,CACH,CAAC;YACF,OAAO,GAAG,CAAC;SACZ;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,IAAA,oBAAU,EAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IAkBD,KAAK,CAAC,kBAAkB,CACtB,aAA8B,EAC9B,YAAoB,EACpB,GAAgB,EAChB,MAAwB,EACxB,SAAmC;QAEnC,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAW,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,EAAE;YACpB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACtB,OAAO,KAAK,CAAC,kBAAkB,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;aACtF;YACD,OAAO,KAAK,CAAC,kBAAkB,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;SACtF;QACD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,GAAG,GAAG,IAAI,GAAG,EAAsC,CAAC;YAC1D,MAAM,OAAO,CAAC,GAAG,CACf,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBAClB,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAA,oBAAU,EAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC;gBACjG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;YACxB,CAAC,CAAC,CACH,CAAC;YACF,OAAO,GAAG,CAAC;SACZ;QACD,OAAO,OAAO,CAAC,SAAS,CAAC,IAAA,oBAAU,EAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC;IACpF,CAAC;IAgBD,KAAK,CAAC,cAAc,CAClB,aAA8B,EAC9B,YAAoB,EACpB,GAAgB,EAChB,MAAwB;QAExB,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAW,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,EAAE;YACpB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACtB,OAAO,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;aACvE;YACD,OAAO,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;SACvE;QACD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,GAAG,GAAG,IAAI,GAAG,EAAe,CAAC;YACnC,MAAM,OAAO,CAAC,GAAG,CACf,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBAClB,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,IAAA,oBAAU,EAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;gBAC9E,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACpB,CAAC,CAAC,CACH,CAAC;YACF,OAAO,GAAG,CAAC;SACZ;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,IAAA,oBAAU,EAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IACrE,CAAC;IA8BD,KAAK,CAAC,YAAY,CAChB,aAA8B,EAC9B,YAAoB,EACpB,GAAgB,EAChB,IAAoC;QAEpC,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAW,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,EAAE;YACpB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACtB,OAAO,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;aACnE;YACD,OAAO,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;SACnE;QACD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,GAAG,GAAG,IAAI,GAAG,EAA6B,CAAC;YACjD,MAAM,OAAO,CAAC,GAAG,CACf,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBAClB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,IAAA,oBAAU,EAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;gBACxG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,CAAC,CAAC,CACH,CAAC;YACF,OAAO,GAAG,CAAC;SACZ;QACD,OAAO,CAAC,MAAM,OAAO,CAAC,KAAK,CAAC,IAAA,oBAAU,EAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvG,CAAC;IAED,WAAW,CAAW,IAAY;QAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,QAAQ,EAAE;YACZ,OAAO,QAA+C,CAAC;SACxD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAnOD,oDAmOC"}